🚀 Next Level Week #02 - API

A REST API responsible for provide data to the web and mobile front-ends.

📌 Table of Contents

• Installation
• Getting Started
• Found a bug? Missing a specific feature?
• Contributing
• License

👷 Installation

You need to install Node.js and Yarn first, then in order to clone the project via HTTPS, run this command:

git clone https://github.com/monteiro-alexandre/proffy-api.git

SSH URLs provide access to a Git repository via SSH, a secure protocol. If you use a SSH key registered in your Github account, clone the project using this command:

git clone [email protected]:monteiro-alexandre/proffy-api.git

Install dependencies

yarn install

Or

npm install

Create your environment variables based on the examples of .env.example

cp .env.example .env

After copying the examples, make sure to fill the variables with new values.

🏃 Getting Started

Run the migrations to configure the database schema

yarn knex:migrate:latest

Run the following command in order to start the application in a development environment:

yarn dev

🐛 Issues

Feel free to file a new issue with a respective title and description on the the Proffy API repository. If you already found a solution to your problem, I would love to review your pull request! Have a look at our contribution guidelines to find out about the coding standards.

🎉 Contributing

Check out the contributing page to see the best places to file issues, start discussions and begin contributing.

📕 License

This project is licensed under the MIT License - see the LICENSE file for details.