The dashboard api is a Node.js API that provides functionality for user registration, login, and link management. The API is designed with security and performance in mind, utilizing various middleware and libraries. It is built with NodeJs, Express, MySql and Sequelize with JWT auth and Yup for validation.
- User registration and login (Only admin can add a new user).
- Link management (CRUD operations).
- JWT Auth.
- Yup for validation.
- Rate limiting for enhanced security.
- Helmet middleware for HTTP header security.
- Sequelize ORM for database interaction.
- Error handling middleware for a robust API.
- Linting with ESLint
- Node.js and yarn installed
- MySQL installed
- Clone the repository:
git clone https://github.com/adriananin/dashboard-api.git
- Install dependencies:
cd dashboard-api
yarn install
- Use the sample
.envfile provided at the root of the project and add the necessary environment variables found in.env. - Login to MySql
mysql -u your_username -pwith your credentials, enter password when prompted. - Create the test, dev and prod databases by entering the command
CREATE DATABASE your_db_name;. - Enter
SHOW DATABASES;to confirm the databases were created. - Update the
./utils/database.jsfile with the appropriate connection details. - Run the admin seed script
yarn seed, the seed script is run in development mode, to run in production mode, change the script in the package.json file. - Run the application
yarn devfor development mode oryarn startfor production.
To run db migration, you can use the sample file in the migrations folder as a starting point and run the migration script with npx sequelize-cli db:migrate.
You can also simply run yarn migrate.
Rate limiting is configured using the express-rate-limit middleware. You can adjust the rate limit and window duration in the ./app.js file.
Security measures such as CORS, helmet, and disabling the 'x-powered-by' header are implemented in the ./app.js file.
To run integration tests, run the test script yarn test.
To run the linter, run the lint script yarn lint.
- POST /api/users/add: Register a new user (only and admin can add a new user).
- POST /api/users/login: Login with existing credentials.
- GET /api/links: Get all links (all users).
- GET /api/links/:id: Get a specific link (all users).
- POST /api/links/create-link: Create a new link (admin only).
- PUT /api/links/:id: Update an existing link (admin only).
- DELETE /api/links/:id: Delete a link (admin only).
Feel free to contribute to the development of this API by opening issues or submitting pull requests.