README.md

Room + Video = Roomeo

“A fictional video server”!

You can manage users and conference rooms.

DDD, TDD, SOLID? Humm, is cheap ? Show me the code!

Prerequisites

Before you begin, ensure you have met the following requirements:

• You have installed the 12.x version of NodeJS
• You have a Yarn 1.x version or NPM.
• You have created psql databases: roomeo_pg, roomeo_test
• or run docker and create databases: roomeo_pg, roomeo_test ❯ docker run --name roomeo_pg -e POSTGRES_PASSWORD=docker -p 5432:5432 -d postgres

Installing Project

To install dependencies, run:

yarn install
yarn typeorm migration:run

Using Project

To use, follow these steps:

yarn dev:server

Or run tests:

yarn test

Aplication Routes

If you want to test on insomnia, postman or similar: Import this json.

• GET /users : list all users;
• GET /users/:username : user information;
• POST /users { username, password, mobile_token} : create and authenticate a user;
• POST /authenticate { username, password } : authenticate user;
• PUT /users { mobile_token, password } : update current authenticated user;
• DELETE /users : deleted current authenticated user;
• POST /rooms { name, capacity } : create and host a room;
• GET /rooms/:guid : room information;
• POST /rooms/:guid/join : joins room and show room information;
• POST /rooms/:guid/leave : leaves room;
• PATCH /rooms/:guid : change room host;
• GET /rooms/?username=:username : list of rooms that the user is in;

Contributing

To contribute to "roomeo_server", follow these steps:

1. Fork this repository.
2. Create a branch: git checkout -b <branch_name>.
3. Make your changes and commit them: git commit -m '<commit_message>'
4. Push to the original branch: git push origin <project_name>/<location>
5. Create the pull request.

Alternatively see the GitHub documentation on creating a pull request.