README.md

ECOLY REST API

Ecoly is a web application that helps schools manage their eco-schools subjects. It allows schools to easily create new activities, schedule meetings, and track progress towards eco-friendly goals.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Before you begin, ensure you have met the following requirements:

Node.js and NPM installed on your local machine An IDE or text editor installed (e.g. VSCode, Sublime Text, Atom)

Installing

Clone this repository to your local machine

git clone https://github.com/TiagoRibeiro25/ecoly-api

Install the dependencies

npm install

Running the application

Before starting the application, ensure you have created a .env file in the root directory of the project. The .env file should contain the configuration variables for the application. See the .env.example file for the required variables.

After creating the .env file, run the following command to start the application

npm start

or

npm run dev

Testing

To run the tests, create a tests.env file in the root directory of the project. The tests.env file should contain the configuration variables for the application. See the env-example file for the required variables. After creating the tests.env file, run the following command to start the tests

npm test