Table of Contents

(click to expand or hide)

1. Requirements
2. Installation
3. Tests
4. Run

Requirements

Installation

1. Clone the repository

   git clone https://github.com/michalgolda/cashly.git

2. Go to cashly_web folder and install web client packages

   pnpm install

3. Go to root folder and pull all images defined in compose files

   docker-compose pull

4. Go to cashly_web folder and create .env.development file based on .env.template file

   NEXTAUTH_URL=http://localhost:3000
   NEXTAUTH_SECRET=qwerty

5. Go to cashly_api folder and create .env.development file based on .env.template file

   SECRET_KEY=123
   DATABASE_URL=sqlite:///cashly.sqlite
   MAIL_USERNAME=noreply@cashly.com
   MAIL_PASSWORD=
   MAIL_PORT=1025
   MAIL_FROM=noreply@cashly.com
   MAIL_SERVER=mail
   MAIL_STARTTLS=False
   MAIL_SSL_TLS=False
   MAIL_USE_CREDENTIALS=False
   MAIL_VALIDATE_CERTS=False

Tests

You can run tests using pytest module

python -m pytest

Run

When you done previous steps you can run the project using a docker-compose command

docker-compose up api mail

After perform this action you can go to the few locations below

• http://localhost:3000 - Web client
• http://localhost:8000 - REST API
• http://localhost:8025 - Web email client