⚙️ Requirements and Dependencies

Before starting, ensure the required technologies are installed.

• Node.JS >= v22
• NPM >= v10
• MySQL >= 8.0

🚀 How to Run the Solution

In the examples of all commands in the text <env> is the name of the environment to perform the migration, e.g. dev or prod.

1. Clone this repository and move to the project directory:

   git clone <repository-url>

2. Install all dependencies:

   npm install

3. For development purposes use dev environment. Configure the database connection by copying the .env.development.example to a new file .env.development. After that put your MySQL credentials of root user:

   # Database Root Configuration
   DB_ROOT_HOST=localhost
   DB_ROOT_PORT=3306
   DB_ROOT_USER=root
   DB_ROOT_PASSWORD=root
   

   Also, new DB user flowy_sql will be created after executing the next command. Credentials of flowy_sql user can be changed:

   # Database App Configuration
   DB_APP_HOST=localhost
   DB_APP_PORT=3306
   DB_APP_USER=flowy_sql
   DB_APP_PASSWORD=securepass
   DB_APP_DATABASE=flowy
   

   For test purposes use test environment: create .env.test file by copying the .env.test.example file.
4. Run script for create databases and user:

   npm run setup:db

5. Run command to apply necessary migrations.

   npm run migrate

6. Run command to create prisma client:

   npm run migrate:generate

7. Run command to build the project:

   npm run build

8. Seeds help you fill your database with initial data for a presentation or project launch. To start creating test data, run the command:

   npm run migrate:seed

9. Start the server:

   npm run start:dev

10. Application will be launched on http://localhost:8080/.

📬 Postman

To use the predefined settings for Postman, import the file flowy.postman_collection.json.

🐋 Docker

Environment variables are taken from .env.development file. You can start containers with the command:

docker-compose --env-file .env.development up -d

To view a list of containers:

docker ps -a

To stop running containers:

docker-compose stop

To stop and delete containers, networks, and associated resources (with volumes):

docker-compose down -v

📫 Mailing Service

Ethereal is a fake SMTP service, mostly aimed at Nodemailer and EmailEngine users (but not limited to). It's a completely free anti-transactional email service where messages never get delivered. To view the letter that the user will receive, you need to log in to this service using a test login and password. Default credentials you can find in .env.development.example file or:

• login:

  corrine.strosin80@ethereal.email
  

• password:

  EEshmbDQ6mKBzprKVK
  

🔁 REST API documentation

The documentation of all available endpoints can be found http://localhost:8080/api. The Swagger library is used.

Migrations

1. To create new migration run command:

   npm run migrate:create --name <migration_name>

2. To refresh all data at the database run command:

   npm run migrate:refresh

👤 Fake Data

To fill the database with demo data of users, companies, events and tickets, run the following command:

npm run migarte:seed

Here is the fake data for presentations.

User data for testing:

• full name:

  Test User
  

• email:

  test.user@flowy.com
  

All users have a password:

Password123!$