Kanban-API

Resources

• Client App: https://kanban-track.vercel.app/

• BaseUrl: track-api-331a.onrender.com

  
  

Technologies and dependencies

• NodeJs 14.17.5 - A cross-platform JavaScript runtime environment for developing server-side applications

• Express 4.18.2 - A NodeJs web application framework that helps manage servers and routes.

• Mongoose ^7.0.0 - A non-relational Database

• Nodemon ^3.0.2 - Detects and automatically restarting the node application when file changes.

• Bycrypt ^5.1.1 - A library to help you hash passwords.

• Cors ^2.8.5 - For cross origin resources sharing.

• Nodemailer ^6.9.8 - For sending email in Nodejs apllication.

• Jsonwebtoken ^9.0.2 - For decode, verify and generating JWT.

• google-auth-library ^9.7.0 - For Google authentication

• EJS ^3.1.9 - A Simple templating language that lets you generate HTML markup with plain JavaScript

• cookie-parser ^1.4.6 - For parsing request cookies

• Eslint ^7.32.0 || ^8.2.0 - Handles codebase Linting, (Eslint standard used)

• Prettier ^2.8.4 - Code formatter to to make code base look pretty

• Husky ^8.0.3 and lint-staged ^13.2.0 - Pre-commit hooks that runs on git commit

  
  

Environment Setup

• Make sure you have nodejs v14.17.5 and above installed. You can install nodejs from here if you don't have it.

• To check node version

  node --version
  

• Clone the respository to your local machine using the command.

  git clone https://github.com/sandygudie/kanban-api.git
  

• Navigate to the project folder.

  cd kanban-api
  

• You can open the project with your code editor (VScode recommended)

  
  

Start the server

• Install the package dependencies by running the following command in the terminal npm install

• Create a .env in the project folder, get example variables from the .env.example file sample and ensure to add the values correctly(e.g MONGODB_URI)

• To start the server locally, run the command npm run dev

  
  

Formatting for the project

• We're using eslint for js linting, and prettier for code formatting.

• Please make it a point to install eslint and prettier plugins on vscode to aid in your coding process.

• Run the command to fix all auto-fixable formatting errors in the whole project based on eslint rules.

  npm run lint
  

• Run the command to check and fix file formatting with prettier

  npm run format
  

• Also linting has been set up for staged commits in the project.

  
  

Deployment on Render

• Application is on auto deploy from Github to Render.