Skip to content

Latest commit

 

History

History
77 lines (47 loc) · 2.21 KB

README.md

File metadata and controls

77 lines (47 loc) · 2.21 KB

Welath App

This is an app for managment of wealth. It allows you to introduce your finance and display different financial statements

What's inside?

This turborepo uses Yarn as a package manager. It includes the following packages/apps:

Apps and Packages

  • api: a fastify api
  • web: a Next.js app
  • ui: a stub React component library shared by applications
  • schemas: a set of TypeBox schemas shared by applications
  • eslintconfig: eslint configurations (includes eslint-config-next and eslint-config-prettier)
  • tsconfig: tsconfig.jsons used throughout the monorepo
  • babelconfig: babel configurations

Setup

A tools.js script exists to handle the development environment installation.

To install all dependencies run the following command:

node tools.js install

To create the environment files run the following command:

node tools.js install-env

Develop

There are two ways to run the local environment to start develop.

  1. Using Docker:

    To build the docker image run the following command:

    node tools.js docker-build
    

    Once the process has finished, you'd need to modify your .env files first according to your setup. Check the default SuperTokens and PostgreSQL configuration in the docker-compose.yml file.

    • apps/api/.env

    • apps/web/.env.local

    To start the local development environment run the following command:

    docker-compose up
    
  2. Without Docker:

    This application depends on:

    You can run those dependencies using Docker or standalone. Please make sure your .env files are configured correctly.

    • apps/api/.env

    • apps/web/.env.local

    To start the development server run the following command:

    yarn dev