My planner API

Table of content

• Table of content
• Project board
• Installation
• Configuration
• Start
• Libraries and frameworks

Project board

You can check the progress of the project on the board in Trello.

Installation

To install the application, you'll need Git and Node.js >= v14. From your command line:

# Clone this repository
$ git clone https://github.com/Jullymac/my-planner-api.git

# Go into the repository
$ cd my-planner-api

# Install dependencies
$ npm install

Configuration

Copy .env.example file to .env and fill up all environment variables, preferably with a postgres database.

Start

You can start the application locally with the following command:

$ node ace serve --watch

It will run at http://localhost:3333

Libraries and frameworks

The main libraries and frameworks used in this project are:

• AdonisJs - v5.8.1
• Prettier - v2.7.1
• EsLint - v8.21.0