ikuzen/tournament-masterpiece

Tournament Masterpiece

A Web app, allowing users to create, manage and participate to their own tournaments.

A singe person fullstack project developped for training purpose.

The project is using the following stacks :

Angular 9 (frontend) ExpressJS (API) MongoDB (database)

How to use :

• clone the project

• run the database :

  • Using Docker :
    • open a Command terminal in the project root
    • type > docker-compose database
  • Without Docker :
    • Download MongoDB compass
    • Create a database with the name Tournament-Masterpiece
    • https://i.imgur.com/oCuVvJl.png
    • 
    • Click on create Collection, and create 2 collections with the name tournaments and users

• run the API

  • Using Docker :
    • open a Command terminal in the project root
    • type docker-compose database
  • Without Docker:
    • open a Command terminal in the project /back directory
    • Type :

    npm install 
    npm run dev

    it will open a server on localhost:3000
    

• run the frontend

  • open a Command terminal in the project /app directory

  •    npm install
       ng serve 

  • it will open a server on localhost:4200

• Once everything is running, open your navigator in localhost:4200

tournament-masterpiece's Issues

As an admin, I want to be able to modify and delete users and tournaments, to moderate the website

an admin is a user with a ADMIN role.

They have specific view in the app that other roles don't have access to.
They have access to more API requests than other roles.
This role can't be attributed via the frontend

in the frontend
WIP
add route guard for admin role to specfic pages
add buttons on tournaments and user to delete or modify

In the API
add JWT verification, and method that check user role
for PUT and DELETE requests

Integrations tests with Cypress

as a tournament organizer, I want to create a tournament so other members can participate to it

As a viewer, I want to access the tournaments and members lists, so that I can keep myself informed.

a viewer is an unknown user with a guest role.
They have access to specific parts of the website and have limited rights.

in the api
GET requests to fetch one/all tournaments and users.
tournament : all informations
user : do not show password.

in the frontend
a page to see a list of all users and all tournaments
a functionnality to search by name

Unit tests with jasmine

As a player, I want create my account so I can log in, and join the community

An account is an User object in database.

In the database
create an User collection

In the Api
a public POST request to create a USER
a USER object must have :
required properties :

• username : string (must be unique in the database, length must be between 3 and 20 characters)

• password : string (must be between 6 and 30 characters, and contain at least one number and one uppercase character)

• email : string (must be a valid email)

• role : string (will be attributed at creation, and set to "member)

• createdAt: Date( will be attributed at creation)

a public POST method login, that will authentify the user, send a token to the front to keep the session active.
In the frontend
A register button in the main page that leads to a registration page.
Can only be accessed if not logged in.
the page contains a form
the fom will have :

• username
• email
• password
• password confirmation
  There must be input validation

*If registration succeeds : must be redirected to login page
*if registration fails : must show the error

The login page : contains a form
the fom will have :

• username
• email
  in case of success, will redirect to home page, and a pop up of success.
  in case of error : show error.

a 'forgot password' button will redirect to a password recovery page

unit tests with jest (API)

stock the token in the cookie

make tournament pagination

Back and front

encryption of the passwords in the database

In order to protect users data.
Password will be encrypted in the database