https://github.com/codemitrayt/blsheetserver

BLSheet backend service.
https://github.com/codemitrayt/blsheetserver

Last synced: about 1 year ago
JSON representation

BLSheet backend service.

• Host: GitHub
• URL: https://github.com/codemitrayt/blsheetserver
• Owner: codemitrayt
• License: mit
• Created: 2024-08-19T02:47:48.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-21T18:29:25.000Z (over 1 year ago)
• Last Synced: 2024-10-22T10:21:46.230Z (over 1 year ago)
• Language: TypeScript
• Homepage: https://bl-sheet-server.vercel.app
• Size: 319 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
BL Sheet Backend 


BL Sheet Backend is the server-side component of the BL Sheet project management and productivity tool. This backend is built using Node.js and provides RESTful APIs to handle project management, task tracking, budget management, and user collaboration functionalities.


Features




  
RESTful API for managing projects, tasks, and budgets

  
User authentication and authorization

  
Real-time collaboration via WebSockets

  
Data storage and retrieval using MongoDB



GitHub Repository




  


Backend (Node.js): BL Sheet Backend GitHub Repository



  
For the frontend, visit the repository here: BL Sheet Frontend Repository





Installation and Setup




  
Clone the backend repository:

  
git clone https://github.com/codemitrayt/BLSheetServer.git


  
Navigate into the project directory:

  
cd BLSheetServer


  
Install the dependencies:

  
npm install


  
Set up environment variables by creating a .env file in the root directory with the reference .env.example


  
Start the server:

  
npm run dev


  
The server will be running at http://localhost:5500.



How to Contribute


We welcome contributions to the backend of BL Sheet! To contribute, follow these steps:




  


Fork the repository on GitHub.

  


Clone your forked repository to your local machine:

  
git clone https://github.com/your-username/BLSheetServer.git


  
Create a new branch for your feature or bug fix:

  
git checkout -b feature/your-feature-name


  


Commit your changes:

  
git commit -m "Add feature or fix description"


  


Push your branch to your forked repository:

  
git push origin feature/your-feature-name


  
Open a Pull Request on the original repository and provide a detailed description of your changes.



Contribution Guidelines




  
Ensure your code follows best practices and is well-documented.

  
Make sure your code passes existing tests and includes new tests for new features.

  
Respectful and constructive feedback is encouraged during code reviews.



License


This project is licensed under the MIT License. See the LICENSE file for details.