Skip to content

Latest commit

 

History

History
183 lines (136 loc) · 6.25 KB

README.md

File metadata and controls

183 lines (136 loc) · 6.25 KB

SystemRank - Server Package 💻

SystemRank API

Status: Finished

About • Separation of requirements • API Routes • How it works • Tech Stack • Author

About

SystemRank API - SystemRank API is an API that works behind SystemRank, thanks to it we are able to perform all CRUD operations and other functionalities

Separation of initial requirements

Functional Requirements (FRs)

  • Users should be able to register as regular users or companies.
  • Users should be able to authenticate.
  • Users should be able to retrieve their profiles.
  • Users or companies should be able to update their profiles.
  • A company should be able to register one or more operating systems (OSs).
  • A company should be able to edit its OSs.
  • A company should be able to delete its OSs.
  • Should be able to fetch all companies
  • Filtering OSs by company should be possible.
  • Retrieving all available OSs on the platform should be possible.
  • Getting details of a specific OS should be possible.
  • Searching for OS names or company profiles should be possible.
  • Rating OSs on a scale of 1 to 5 and leaving comments should be possible.
  • Editing existing reviews should be possible.
  • Deleting reviews should be possible.
  • Should be able to fetch all reviews of a system
  • Should be able to fetch all reviews of a user

Business Rules (BRs)

  • Users should not be able to register with a duplicated email.
  • Two OSs with the same name should not exist.
  • Users should not be able to submit two reviews for the same OS, but they can edit their reviews.

Non-Functional Requirements (NFRs)

  • User passwords must be encrypted.
  • Application data must be persisted in a PostgreSQL database with Docker.
  • All data lists must be paginated with 20 items per page.
  • Users should be identified by a JWT (JSON Web Token).
  • The JWT must use the RS256 algorithm.

API Routes

  • Users
    • POST /users - Register a new user/company
    • POST /sessions - Sign in and generate JWT
    • GET /users/:userId - Get user profile
    • GET /companies - Query companies by name or find all
    • PATCH /users - Update current logged user Require a valid Bearer Token in the req's header
    • PATCH /token/refresh - Refresh token Require a valid Bearer Token on request cookies
  • Systems
    • POST /systems - Register a new system Require a valid Bearer Token in the req's header and user role equal COMPANY
    • GET /systems - Query systems by name or find all
    • GET /systems/:systemId - Get system details by ID
    • GET /systems/company/:companyId - Fetch all systems of a company
    • PATCH /systems/:systemId - Update system details Require a valid Bearer Token in the req's header and user role equal COMPANY
    • DELETE /systems/:systemId - Delete a system Require a valid Bearer Token in the req's header and user role equal COMPANY
  • Reviews
    • POST /reviews/system/:systemId - Create a new review for a system Require a valid Bearer Token in the req's header
    • GET /reviews/system/:systemId - Fetch all reviews of a system
    • GET /reviews/user/:userId - Fetch all reviews of a user
    • PATCH /reviews/:reviewId - Update reviews details Require a valid Bearer Token in the req's header
    • DELETE /reviews/:reviewId - Delete a review Require a valid Bearer Token in the req's header

How it works

Pre-requisites

Before you begin, you will need to have the following tools installed on your machine: Git, Node.js and PNPM package manager. In addition, it is good to have an editor to work with the code like VSCode and a REST client like Insomnia

You will also need to have Docker installed to run the postgres database with Docker Compose

it is very important that before running the project you configure the environment variables as indicated in the file: .env.example

Run the app

# Clone this repository
$ git clone https://github.com/Artur-Poffo/SystemRank.git

# Access the project folder cmd/terminal
$ cd SystemRank

# install the dependencies
$ pnpm install

# Access the server package folder cmd/terminal
cd packages/server

# Inicialize the database
# In the server package directory after installing docker, run:
$ pnpm docker:init
# This script should create, start and execute migrations in a container with Postgres database

# Then when you want to stop running docker, run:
$ pnpm docker:stop
# Or just press Ctrl+c

# When you want start the container again, run
$ pnpm docker:start

# Remember to create the RSA keys for the JWT, instructions in the .env.example file

# Run the application in development mode
$ pnpm dev

# The server will start at port: 3333 - You can now test in Insomnia or another REST client: http://localhost:3333

Run tests

# Run unit tests
$ pnpm test

# Run unit tests in watch mode
$ pnpm test:watch

# Run test coverage
$ pnpm test:cov

Tech Stack

The following tools were used in the construction of the project:

  • Node.js
  • TypeScript
  • tsx
  • tsup
  • Fastify
  • @Fastify/jwt
  • @Fastify/cookie
  • bcrypt
  • zod
  • prisma
  • vitest
  • supertest
  • Docker

See the file package.json

Author

  • Artur Poffo - Developer

Linkedin Badge Gmail Badge