Floesia API

API for managing Floesia. You can find the frontend of this project here.

---

Contributing

If you want to contribute to this project, take a look at the issues section, make a fork of this repository, be respectful with others and go on. All help is welcome. Also, before contributing, be sure to read our Contributing Guidelines and our Code of Conduct since you need to agree with them before contributing to this repository.

Setting up a Development Environment

If you are planning on contributing to this project or just wanna play with it. You'll going to need to setup a local development environment. Here are some guidelines you can follow in order to make it done.

1. Clone the repository

If you are going to contribute to it, first make a fork of it and then clone it in your local machine.

git clone https://github.com/yourGithubUsername/floesia-api

If you're only going to test it out, you can directly clone this repository with:

git clone https://github.com/raymag/floesia-api

2. Install dependencies

This project is build using NodeJS, so you'll need to have it installed on your local machine.

Now that you have already clonned the repository, open up the terminal on the clonned folder and use yarn or npm to install the node dependencies:

For npm:

npm install

For yarn:

yarn install

3. Setup .env file

In order to function properly, this project depends on some environment variables which you can define with a .env file. You can take a look at the .env_example to see how to implement your own .env file.

4. Run

Now all you need to do is execute the project and you're set to do whatever you want to. For npm:

npm run dev

For yarn:

yarn run dev