Skip to content

phoenixadi2002/fstruct-backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Here’s a sample README for your Express backend project. You can customize it further based on your specific project details and requirements.

Fstruct Backend

Welcome to the Fstruct Backend! This is a RESTful API built with Express.js for handling backend operations for the Fstruct application.

Table of Contents

Features

  • RESTful API built with Express.js
  • User authentication and authorization
  • Data storage with MongoDB (or any other database you are using)
  • Environment configuration using .env files

Installation

  1. Clone the repository:

    git clone https://github.com/phoenixadi2002/fstruct-backend.git
    cd fstruct-backend
  2. Install the dependencies:

    npm install
  3. Create a .env file: Copy the env.example file to .env and fill in the necessary environment variables.

    cp env.example .env

Configuration

Make sure to configure the following environment variables in your .env file:

  • PORT - The port on which the server will run (default is 3000).
  • DATABASE_URL - Your database connection string.
  • Any other environment-specific variables required for your application.

Usage

To start the server, run:

npm start

This will start the server on the specified port. You can access the API at http://localhost:<PORT>.

API Endpoints

Folder Management

Method Endpoint Description
GET /folder/rootFolder Create or retrieve the root folder
POST /folder/create Create a new subfolder
POST /folder/show Retrieve contents of a specific folder
POST /folder/move Move a folder
POST /folder/update/:folderId Update folder details
POST /folder/delete/:folderId Delete a folder by its ID

File Management

Method Endpoint Description
POST /file/create Create a new file
POST /file/move Move a file
POST /file/update Update file details
POST /file/delete/:fileId Delete a file by its ID

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue for discussion.

  1. Fork the repository.
  2. Create a new branch for your feature:
    git checkout -b feature/YourFeature
  3. Commit your changes:
    git commit -m "Add your feature"
  4. Push to the branch:
    git push origin feature/YourFeature
  5. Create a new Pull Request.

About

backend for file tree

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors