Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/diegovictor/happy-api

Project built during Rocketseat's Next Level Week #3
https://github.com/diegovictor/happy-api

coverage-report editorconfig eslint happy javascript js nextlevelweek nextlevelweek-booster nlw nlw-booster node nodejs rocketseat sqlite sqlite3 ts typeorm typescript

Last synced: about 2 months ago
JSON representation

Project built during Rocketseat's Next Level Week #3

Host: GitHub
URL: https://github.com/diegovictor/happy-api
Owner: DiegoVictor
License: mit
Created: 2020-10-13T12:04:47.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2024-08-12T14:04:15.000Z (4 months ago)
Last Synced: 2024-08-12T16:15:42.361Z (4 months ago)
Topics: coverage-report, editorconfig, eslint, happy, javascript, js, nextlevelweek, nextlevelweek-booster, nlw, nlw-booster, node, nodejs, rocketseat, sqlite, sqlite3, ts, typeorm, typescript
Language: TypeScript
Homepage:
Size: 937 KB
Stars: 10
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # [API] Happy

![CircleCI](https://img.shields.io/circleci/build/github/DiegoVictor/happy-api?style=flat-square&logo=circleci)

[![typescript](https://img.shields.io/badge/typescript-5.5.4-3178c6?style=flat-square&logo=typescript)](https://www.typescriptlang.org/)

[![sqlite3](https://img.shields.io/badge/sqlite-5.1.7-003b57?style=flat-square&logo=sqlite&logoColor=white)](https://www.sqlite.org)

[![eslint](https://img.shields.io/badge/eslint-8.57.0-4b32c3?style=flat-square&logo=eslint)](https://eslint.org/)

[![airbnb-style](https://flat.badgen.net/badge/style-guide/airbnb/ff5a5f?icon=airbnb)](https://github.com/airbnb/javascript)

[![jest](https://img.shields.io/badge/jest-29.7.0-brightgreen?style=flat-square&logo=jest)](https://jestjs.io/)

[![coverage](https://img.shields.io/codecov/c/gh/DiegoVictor/happy-api?logo=codecov&style=flat-square)](https://codecov.io/gh/DiegoVictor/happy-api)

[![MIT License](https://img.shields.io/badge/license-MIT-green?style=flat-square)](https://raw.githubusercontent.com/DiegoVictor/happy-api/main/LICENSE)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)


[![Run in Insomnia}](https://insomnia.rest/images/run.svg)](https://insomnia.rest/run/?label=Happy&uri=https%3A%2F%2Fraw.githubusercontent.com%2FDiegoVictor%2Fhappy-api%2Fmain%2FInsomnia_2024-08-11.json)

Responsible for provide data to the [`web`](https://github.com/DiegoVictor/happy-web) and [`mobile`](https://github.com/DiegoVictor/happy-app) front-ends. Permit to register orphanages. The app has validation, also a simple versioning was made.

## Table of Contents

* [Installing](#installing)

  * [Configuring](#configuring)

    * [SQLite](#sqlite)

      * [Migrations](#migrations)

    * [.env](#env)

* [Usage](#usage)

  * [Versioning](#versioning)

  * [Routes](#routes)

    * [Requests](#requests)

* [Running the tests](#running-the-tests)

  * [Coverage report](#coverage-report)

# Installing

Easy peasy lemon squeezy:

```

$ yarn

```

Or:

```

$ npm install

```

> Was installed and configured the [`eslint`](https://eslint.org/) and [`prettier`](https://prettier.io/) to keep the code clean and patterned.

## Configuring

The application use just one database: [SQLite](https://www.sqlite.org/index.html). For the fastest setup is recommended to use [docker-compose](https://docs.docker.com/compose/), you just need to up all services:

```

$ docker-compose up -d

```

### SQLite

Store the orphanages. For more information to how to setup your database see:

* [typeorm](https://typeorm.io/#/using-ormconfig)

> You can find the application's `ormconfig.json` file in the root folder.

#### Migrations

Remember to run the database migrations:

```

$ yarn ts-node-dev ./node_modules/typeorm/cli.js migration:run -- -d ./src/database/datasource.ts

```

Or:

```

$ yarn typeorm migration:run -- -d ./src/database/datasource.ts

```

> See more information on [TypeORM Migrations](https://typeorm.io/#/migrations).

### .env

In this file you may configure your app's port and a url. Rename the `.env.example` in the root directory to `.env` then just update with your settings.

|key|description|default

|---|---|---

|APP_PORT|Port number where the app will run.|`3333`

|BASE_URL|App's url.|`http://localhost:3333`

# Usage

To start up the app run:

```

$ yarn dev:server

```

Or:

```

npm run dev:server

```

## Versioning

A simple versioning was made. Just remember to set after the `host` the `/v1/` string to your requests.

```

GET http://localhost:3333/v1/orphanages

```

## Routes

|route|HTTP Method|params|description

|:---|:---:|:---:|:---:

|`/orphanages`|GET| - |Lists orphanages.

|`/orphanages/:id`|GET|`:id` of the orphanage.|Return one orphanage.

|`/orphanages`|POST|Body with new orphanage [form data](https://developer.mozilla.org/docs/Web/API/FormData) (See insomnia file for good example).|Create a new orphanage.

### Requests

* `POST /orphanages`

Request body:

```multipart

{

  "name": "Hackett, Becker and Fadel",

  "latitude": -85.8713,

  "longitude": -73.3957,

  "about": "Adipisci cupiditate illo rerum sunt tempore. Non voluptate laborum enim hic tenetur perspiciatis sint. Quo totam recusandae dolores et ullam commodi. Ut consectetur saepe id voluptatem et quidem. Dolor neque consequuntur ipsa. Placeat sit aut nostrum similique dolorem voluptatem et velit enim.",

  "instructions": "Venha visitar",

  "opening_hours": "Das 8h às 18h",

  "open_on_weekends": true,

  "images": 

}

```

# Running the tests

[Jest](https://jestjs.io/) was the choice to test the app, to run:

```

$ yarn test

```

Or:

```

$ npm run test

```

## Coverage report

You can see the coverage report inside `tests/coverage`. They are automatically created after the tests run.