Welcome to the Plan D API repository! This API serves as the backend for the Plan D web application, designed specifically for architecture teams. It facilitates various levels of user access and provides essential functionalities to help architecture team managers and members manage their work and processes digitally. By streamlining workflows and centralizing project management, Plan D enables teams to focus on more critical tasks.
- User Management: Register new users, authenticate existing users, and manage user profiles with different levels of access.
- Task Management: Create, read, update, and delete tasks for team members, facilitating project organization and collaboration.
- Authentication: Secure user authentication using JWT tokens, ensuring data privacy and security.
- Data Validation: Input validation to maintain data integrity and security, preventing unauthorized access or manipulation.
- Error Handling: Comprehensive error handling to provide meaningful responses and enhance user experience.
- Clone the Repository:
git clone https://github.com/amahmadnia/plan-d-api.git - Install Dependencies:
npm install - Set Environment Variables: Create a
.envfile based on.env.exampleand configure your environment variables. - Start the Server:
npm start
- Endpoints: Explore the available endpoints and their functionalities in the documentation.
- Authentication: Obtain an authentication token by registering or logging in. Include this token in the Authorization header for protected routes.
We welcome contributions from the community! If you'd like to contribute to the development of Plan D API, please follow these steps:
- Fork the repository
- Create your feature branch:
git checkout -b feature-name - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin feature-name - Submit a pull request
This project is licensed under the MIT License.