TriTogether - API

REST api for tritogether app. An open source triathlon training application.

Pre-reqs

Docker
Node

Getting started

Create file .env using .example.env as a base and configure the database connection (postgres included already in the docker-compose).

Then run:

docker-compose up -d
npm run watch-server

npm run test:integration:local

Frontend

This is just the API part, the frontend (ionic app) is located in another repo.

How to create a DB migration

Either make the change in the DB and generate the migration using TypeORM, although this method looks a bit tricky to me and you have to configure the typeORM cli locally and hardcode a DB connection in a ormconfig.json file. This method might be worth in case generating the queries manually sounds very tricky to you.

What I would recommend is just creating a new .ts file in src/migration dir, generating the timestamp manually and writing the query yourself.

Migrations will be executed on application startup due to the configuration specified in the DB connection.

Support email configuration

Some functionalities within the application send emails (such as recovery password service). Nodemailer is used for that, and the email configuration is specified in the .env file. If you don't have a real email account for testing, you can use this configuration in EmailService:

// Generate test SMTP service account from ethereal.email
// Only needed if you don't have a real mail account for testing
let testAccount = await nodemailer.createTestAccount();

// create reusable transporter object using the default SMTP transport
let transporter = nodemailer.createTransport({
    host: "smtp.ethereal.email",
    port: 587,
    secure: false, // true for 465, false for other ports
    auth: {
      user: testAccount.user, // generated ethereal user
      pass: testAccount.pass, // generated ethereal password
    },
});