About the project | Technologies | Getting started | License
This REST API provides all the functionality to manage a complete Kaban Board application.
Features project management and task management, with full user authentication.
To see the front-end client, built with React, click here: KanbanBoard
Technologies that I used to develop this api
- Node.js [Runtime Environment]
- TypeScript [Typesafe Language]
- Express [Web Server]
- Prisma [ORM]
- JWT-token [Authentication]
- PostgreSQL [Database]
- Date-fns [Handling Date]
- Eslint [Code Linting]
- Prettier [Code Formatting]
- Node.js
- Yarn or npm
- An instance of PostgreSQL
Clone the project and access the folder
$ git clone https://github.com/chamatt/KanbanBoard-Backend.git && cd tasks-api
Follow the steps below
# Install the dependencies
$ yarn
# Make a copy of '.env.example' to '.env'
# and set with YOUR environment variables.
$ cp .env.example .env
# Make a copy of 'prisma/.env.example' to 'prisma/.env'
# and set DATABASE_URL to your postgres configs.
# it should look somewhat like this:
# DATABASE_URL="postgresql://<username>:<password>@localhost:5432/<database>?schema=public"
$ cp prisma/.env.example prisma/.env
# Once the services are running, run the migrations
$ yarn prisma migrate up --experimental
# It will ask if you want to create a new database, say *yes*.
# To finish, run the api service
$ yarn dev:server
# Well done, project is started!
This project is licensed under the MIT License - see the LICENSE file for details.