Skip to content

nrademacher/todo

Repository files navigation

☑️ Todo (WIP)

Full-stack Todo app

Getting Started

Prerequisites

Here is what you need to be able to run the app locally.

  • Node.js (latest or LTS)
  • pnpm
  • Docker (for MySQL development and test databases)

Development

  1. Clone the repository

    git clone https://github.com/nrademacher/todo.git
  2. Go to the project folder

    cd todo
  3. Install packages with yarn

    pnpm install
  4. Set up your .env file

    • Duplicate .env.example to .env
    • Use openssl rand -base64 16 (or 8, 16, 24) to generate keys and add them for JWT_SECRET and DB_PASSWORD in the .env file.
  5. Create soft links to your .env file in the server and client apps

    ln -s .env apps/server/.env
    ln -s .env apps/client/.env
  6. Start up the development and test databases

    pnpm db:up
  7. Start the app (server and client)

    pnpm dev
  8. See package.json for further commands