https://github.com/santospatrick/yardstick

https://github.com/santospatrick/yardstick

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/santospatrick/yardstick
• Owner: santospatrick
• Created: 2022-07-20T16:47:47.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-07-20T16:48:14.000Z (over 2 years ago)
• Last Synced: 2024-11-09T17:46:36.860Z (2 months ago)
• Language: JavaScript
• Size: 573 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Adonis API application

> 🔺 Inovando's template for adonis

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

![Package Main Techs](docs/techs.png)

## Usage

1. Setup a [PostgreSQL](#postgresql)

2. Modify `.env` fulfilling variables as needed

3. Initialize your project with this command:

```bash

adonis new yardstick --blueprint=inovando/adonis-api-app

adonis migration:refresh --seed

```

4. Run the following command:

```bash

adonis serve --dev

```

5. Done 🎉

### PostgreSQL

#### Local install

[Follow this link](https://www.postgresql.org/download/)

#### Docker

```bash

docker run --name some-postgres -e POSTGRES_PASSWORD=mysecretpassword -p 5432:5432 -d postgres

```

### Migrations

Run the following command to run startup migrations.

```js

adonis migration:run

```

### Seeds

Run the following command to run recreate the database and seed.

```js

adonis migration:refresh --seed

```

### Postman

1. Download [Postman](https://www.postman.com/downloads/)

3. Import our [Postman Collection](https://learning.postman.com/docs/postman/collections/intro-to-collections/) from `postman/Template Adonis.postman_collection.json`

![Postman Collection | First Step](docs/postman-collection-1.png)

![Postman Collection | Second Step](docs/postman-collection-2.png)

4. Import our [Postman Environment](https://learning.postman.com/docs/postman/variables-and-environments/managing-environments/) from `postman/Template Adonis.postman_environment.json`

![Postman Environment | First Step](docs/postman-environment-1.png)

![Postman Environment | Second Step](docs/postman-environment-2.png)

![Postman Environment | Second Step](docs/postman-environment-3.png)

### Features

- [x] Bodyparser

- [x] Authentication

- [x] CORS

- [x] Lucid ORM

- [x] Migrations and seeds

- [x] Abstração Controller/Repository

- [x] [Bumblebee (include)](https://github.com/rhwilr/adonis-bumblebee)

- [x] Enviar e-mails

- [x] Método para autenticar, resetar senha

- [x] Endpoints `/me`

- [x] Abstração de profiles

- [x] Upload de arquivos genérico

- [x] Sentry

- [x] Redis Cache

- [x] User and Profile Seeder

- [x] Commitizen Friendly