AdonisJS API Project

A blog project, users have a profile and some tasks, they can create, edit and delete them. Validation and Authentication have also been implemented.

• User Manual:
  • How To Set Up And Use
  • Routes
  • Models
  • ENUMS

Setup

How To Use (Windows/Linux)

1 - Clone the project, go inside the folder and install packages with: npm install

2 - Create a .env file, examples are in .env.example you can just copy them for now.

3 - You will need a MySQL server running, also create the user and database you want to use inside the .env file.

4 - You can generate an app key with: node ace generate:key and add/replace it in your .env APP_KEY.

5 - Migrate the database with: node ace migration:run

(The Roles/Priorities will be automatically inserted to their tables in the database using thier Enums)

6 - You can automatically generate some info in the database if you want, using: node ace db:seed

7 - Now start the app with: node ace serve or npm run dev

(At any point you can use node ace migration:refresh if you want to remove the existing data from database or make any changes to migrations)

Now you can open postman and test these routes (on http://localhost:3333):

Routes:

Users:

GET:
/users
(returns all users and their profiles)
Optional Query Strings:
- pagination: ?page=1&page_size=2

GET:
/users/:id
(returns user by id)

POST:
/users/:id
(enter user information, optional profile picture, creates user by id)

PATCH-PUT:
/users/:id
(enter user information, optional profile picture, edits user by id)

DELETE:
/users/:id
(deletes user by id)

Tasks:

GET:
/users/id:/tasks
(returns all tasks from a user by user_id)
Optional Query Strings:
- pagination: ?page=1&page_size=2
- searching title: ?search=something
- sorting: ?sort=name&sort_type=asc [sort: name/created_at, sort_type: asc/desc]

GET:
/users/:user_id/tasks/:id
(returns a task from a user by user_id and task id)

POST:
/users/:user_id/tasks/:id
(enter task information, optional thumbnail picture, creates a task for a user by user_id and task id)

PATCH-PUT:
/users/:user_id/tasks/:id
(enter task information, optional thumbnail picture, edits a task for a user by user_id and task id)

DELETE:
/users/:user_id/tasks/:id
(deletes a task from a user by user_id and task id)

Auth:

POST:
/register
(enter user information to create and login user, returns bearer token)

POST:
/login
(enter email and password, returns bearer token)

POST:
/logout
(enter Bearer Token, revokes the token)

---

Models:

Users:

id                (database generated)
roleId            (relation)
email             (unique, 255)
password          (hashed, 180)
username          (unique, 30)
age               (optional)
name              (optional, 15)
familyName        (optional, 15)
rememberMeToken   (optional)
created_at        (database generated)
updated_at        (database generated)

Profiles:

id                (database generated)
userId            (relation)
biography         (optional)
picture           (image, optional)
created_at        (database generated)
updated_at        (database generated)

Tasks:

id                (database generated)
priorityId        (relation)
userId            (relation)
title             (100)
body              (optional)
thumbnail         (image, optional)
created_at        (database generated)
updated_at        (database generated)

---

ENUMS:

Roles:

MEMBER
PROMEMBER
MODERATOR
ADMIN

Priorities:

LOW
MEDIUM
HIGH