https://github.com/arrudadev/proffy-api
REST API of the 2ª Next Level Week project.
https://github.com/arrudadev/proffy-api
backend express knexjs nodejs sqlite typescript
Last synced: 3 months ago
JSON representation
REST API of the 2ª Next Level Week project.
- Host: GitHub
- URL: https://github.com/arrudadev/proffy-api
- Owner: arrudadev
- License: mit
- Created: 2020-12-22T22:38:51.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-06T21:36:14.000Z (over 5 years ago)
- Last Synced: 2026-01-03T16:05:16.092Z (6 months ago)
- Topics: backend, express, knexjs, nodejs, sqlite, typescript
- Language: TypeScript
- Homepage:
- Size: 312 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
🚀 Next Level Week #02 - API
> A REST API responsible for provide data to the [`web`](https://github.com/monteiro-alexandre/proffy-web) and [`mobile`](https://github.com/monteiro-alexandre/proffy-mobile) front-ends.
[](https://insomnia.rest/run/?label=Proffy%20API&uri=https%3A%2F%2Fgithub.com%2Fmonteiro-alexandre%2Fproffy-api%2Fblob%2Fmaster%2FInsomnia-workspace.json)
[](https://codecov.io/gh/monteiro-alexandre/proffy-api)
[](https://opensource.org/licenses/MIT)
[](http://makeapullrequest.com)
# :pushpin: Table of Contents
* [Installation](#construction_worker-installation)
* [Getting Started](#runner-getting-started)
* [Found a bug? Missing a specific feature?](#bug-issues)
* [Contributing](#tada-contributing)
* [License](#closed_book-license)
# :construction_worker: Installation
**You need to install [Node.js](https://nodejs.org/en/download/) and [Yarn](https://yarnpkg.com/) 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 git@github.com: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.
# :runner: 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```
# :bug: Issues
Feel free to **file a new issue** with a respective title and description on the the [Proffy API](https://github.com/monteiro-alexandre/proffy-api/issues) 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](https://github.com/monteiro-alexandre/proffy-api/blob/master/CONTRIBUTING.md) to find out about the coding standards.
# :tada: Contributing
Check out the [contributing](https://github.com/monteiro-alexandre/proffy-api/blob/master/CONTRIBUTING.md) page to see the best places to file issues, start discussions and begin contributing.
# :closed_book: License
This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.