Home

API Rest Full perf N Zen

API qui permet de faire l'interface entre le front et la base de données du projet perf N Zen

Table of Contents

• Table of Contents
• About the Project
  • Built With
  • deployment
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License

➤ About the Project

Built With

• NodeJS
• Express
• typescript
• prisma
• PostgreSQL
• JWT
• Jest

Deployment

Deployed on Vercel at https://api-perf-n-zen.vercel.app/

➤ Getting Started

Prerequisites

• npm

npm install npm@latest -g

• node

npm install node@latest -g

Installation

1. Clone the repo

git clone https://github.com/perf-n-zen/api.git

2. Install NPM packages

npm install

3. Create a .env file and add the following variables

DATABASE_URL="postgresql://<username>:<password>@<host>:<port>/<database>?schema=<schema>"
PORT=3000
ACCESS_TOKEN_SECRET=424XXXXXXXX
REFRESH_TOKEN_SECRET=424XXXXXXXX

4. Run the project

npm run dev

➤ Usage

➤ License

Distributed under the MIT License. See LICENSE for more information.