Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mister-fix/taskguardian-api
TaskGuardian API is a powerful backend service designed to manage tasks, users, and projects for the TaskGuardian platform.
https://github.com/mister-fix/taskguardian-api
api express jwt node rest-api
Last synced: 24 days ago
JSON representation
TaskGuardian API is a powerful backend service designed to manage tasks, users, and projects for the TaskGuardian platform.
- Host: GitHub
- URL: https://github.com/mister-fix/taskguardian-api
- Owner: mister-fix
- License: mit
- Created: 2024-09-14T03:45:02.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-16T01:27:25.000Z (4 months ago)
- Last Synced: 2024-10-31T02:42:01.703Z (2 months ago)
- Topics: api, express, jwt, node, rest-api
- Language: JavaScript
- Homepage: https://taskguardian-api.fly.dev/api
- Size: 825 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Security: docs/SECURITY.md
Awesome Lists containing this project
README
# 
TaskGuardian API is a powerful backend service designed to manage tasks, users, and projects for the TaskGuardian platform. This Node.js-based API provides endpoints for task management, user authentication, and other essential features required for efficient task handling and project tracking. It is built with modern web technologies and adheres to best practices for performance, security, and maintainability.
## Features
- User Authentication: Secure login, registration, and session management using JWT (JSON Web Tokens).
- Task Management: Full CRUD operations (Create, Read, Update, Delete) for tasks, projects, and user assignments.
- Project Organization: Create and manage projects, assign tasks to users, and track progress.
- Robust Error Handling: Centralized error handling for consistent responses.
- Database Connectivity: Built-in support for MongoDB using Mongoose, with automatic retries on failed database connections.
- Logging: Comprehensive logging using a custom logger for tracking API events, errors, and database connections.
- Rate Limiting & Security: API security is enhanced with request rate limiting and HTTP header protection (via Helmet).
- Modular Design: Clean and modular architecture with clear separation between routes, controllers, services, and utilities.
- Scheduled Task Retry: Utility to handle retries for failed tasks with countdown mechanisms.
## Quick Start
Follow the steps below to get TaskGuardian API up and running on your local machine or deployed to Fly.io. These quick start instructions assume you have Node.js, NPM, Docker, and the GitHub CLI installed on your machine.
### Clone the Repository
```bash
git clone https://github.com/mister-fix/taskguardian-api.git
cd taskguardian-api
```
### Install Dependencies
```bash
npm install
```
### BUild and Start the API (with Docker)
```bash
docker build -t taskguardian-api .
docker run -p 3000:3000 taskguardian-api
```
### Access the API
Once the API is running, you can access it locally at: [http://localhost:3000/api](http://localhost:3000/api)
Alternatively, the API is accessible via the web at: [https://taskguardian-api.fly.dev/api](https://taskguardian-api.fly.dev/api). This URL provides access to the TaskGuardian API endpoints, allowing interaction with the API from any web client or tool like Postman or Hoppscotch.
## API Documentation
The API provides the following key endpoints:
- `GET /tasks`: Get a list of all tasks.
- `POST /tasks`: Create a new task.
- `PUT /tasks/:id`: Update an existing task.
- `DELETE /tasks/:id`: Delete a task.
- `POST /auth/register`: Register a new user.
- `POST /auth/verify-email:token`: Verify a user's email address using a token.
- `POST /auth/login`: Login a user and retrieve a JWT token.
- `POST /auth/forgot-password`: Request a password reset link for the user.
- `POST /auth/reset-password/:token`: Reset a user's password using a reset token.
Detailed API usage documentation is coming soon.
## Project Structure
```ASCII
taskguardian-api/
├─ .cspell/ # Spellcheck files
├─ .github/ # GitHub CI/CD workflows and issue templates
├─ .husky/ # Git hooks for commit checks
├─ .vscode/ # VSCode settings and extensions
├─ docs/ # GitHub supporting documents and templates
├─ plop-templates/ # Code generation templates (e.g., controllers, services)
├─ src/ # Main source code directory
│ ├─ config/ # Configuration files (e.g., database, environment)
│ ├─ controllers/ # API route handlers
│ ├─ middleware/ # Express middleware functions
│ ├─ routes/ # API routes (e.g., tasks, users)
│ ├─ utils/ # Utility functions (e.g., retry mechanisms, logger)
│ ├─ app.js # Express app setup
├─ tests/ # API Integration tests directory
├─ .commitlintrc.js # Commit message linting configuration
├─ .dockerignore # Docker ignore rules for builds
├─ .editorconfig # Editor configuration for consistent coding styles
├─ .env.example # Example .env file
├─ .eslintignore # Files and directories to ignore for ESLint
├─ .eslintrc.js # ESLint configuration for code linting
├─ .gitattributes # Git attributes for the project
├─ .gitignore # Git ignore rules for the project
├─ .prettierignore # Files and directories to ignore for Prettier
├─ .prettierrc # Prettier configuration for code formatting
├─ CHANGELOG.md # Changelog for project updates
├─ cspell.json # Configuration for spellcheck
├─ Dockerfile # Docker image for the application
├─ fly.toml # Fly.io deployment configuration
├─ index.js # Application entry point
├─ jsconfig.json # JavaScript project configuration (aliases)
├─ jsdoc.config.json # JSDoc configuration
├─ LICENSE # Project license
├─ logo-light.svg # Light mode logo for the project
├─ logo.svg # Primary logo for the project
├─ nodemon.json # Nodemon configuration for automatic server restarts
├─ package-lock.json # Locked versions of dependencies
├─ package.json # Project metadata and dependencies
├─ plopfile.js # Plop.js configuration for code generation
├─ README.md # Project documentation
```
## Installation
Project installation instructions are currently being prepared.
## Built With
- [ESLint](https://eslint.org/) - Tool for identifying and reporting on patterns found in code.
- [Prettier](https://prettier.io/) - Code formatter.
- [Husky](https://typicode.github.io/husky/) - Manage Git hooks.
- [GitHub Actions](https://docs.github.com/en/actions) - CI/CD workflows.
## Author
Created and maintained by [@mister-fix].
## Contributing
Contributions are welcome! Please follow the guidelines outlined in the [CONTRIBUTING.md](./docs/CONTRIBUTING.md) file for details on how to contribute.
## Code of Conduct
Please adhere to our [Code of Conduct](./docs/CODE_OF_CONDUCT.md) when participating in the community.
## Contributors
[@mister-fix] 🐉
## Contact
For any technical project questions or inquiries, send an email [here](mailto:[email protected]).
## License
This project is available under [MIT License](./LICENSE). You can learn more about open-source licenses here: [choosealicense.com]
## Acknowledgements
- Inspired by modern web application architectures.
- Built with best practices for security and performance in mind.
- Special thanks to the open-source community for their valuable contributions.
## Miscellaneous
- Emojis used in the project markdown files are provided by [@rxaviers], you can [check them out here].
- Badges and shields used in the project markdown files are generated by [img.shields.io].
[@mister-fix]: https://github.com/mister-fix/
[choosealicense.com]: https://choosealicense.com
[@rxaviers]: https://github.com/rxaviers
[check them out here]: https://gist.github.com/rxaviers/7360908
[img.shields.io]: https://img.shields.io/