H-isaac23 / CodeWars

PVP online coding game

CS CODEWARS

Team Collaboration

Trello Link

Figma Link

Frontend

The frontend uses reactjs with vite

Use the public folder for images and assets.

For styling there is css, so do not ever put any css inline unless absolutely required. Css files will be put in the same directory as the route it is styling.

Backend

The backend uses Express.js as server for hosting a REST API, which is all set up inside the src/index.ts. Backend also uses several other library:

• Mongoose as ODM for Mongo DB
• cors as enabler for CORS requests

Backend Folder Structure

backend
├───models
    └───account.js
├───routers
    └───accounts.js
    └───login.js
├───utils
├───.env.example
├───.gitignore
├───app.js
├───index.js
├───io.js
├───package-lock.json
└───package.json

Available Scripts

In the root directory of the project, the following commands are:

yarn dev

Runs both the frontend and the backend concurrently.

yarn devFrontend

Runs the frontend server in development mode.
The website can be accessed in http://localhost:5173.

yarn devBackend

Runs the backend server in development mode.
The server will be listening for calls in http://localhost:3000.

Test Accounts

• Username: server-1-test Password: server-1-test

Contributing

Follow these steps:

1. Fork the repository from here.

2. Clone your fork locally.

3. Optional, but recommended: Create a new branch on the latest commit of the branch you want to contribute to.

4. Commit to the new branch (or the branch you want to contribute to, if you decided not to make a new branch).

5. Push to your fork.

6. Create a pull request from the branch you committed to in your fork to the branch you want to contribute to in the original repository. We don't have a format for pull request descriptions, but please include any details that would help a reviewer.