[Under construction] Set up documentation - DevelopingSpace/starchart GitHub Wiki

For now it's a mess of collected instructions, they will become a comprehensive and step-by-step guide eventually

PostgreSQL

Dev environment setup

# Install dependencies
$ npm install

# Create an .env based on the example
$ cp .env.example .env

# Start MySQL in docker
$ docker compose up
# Wait for the db to finish starting, it takes a few seconds before it's ready...

# Setup the database
$ npm run setup

# Start the app, which will be running on localhost:3000
$ npm run dev

# You can visually see the database using:
$ npm run db:studio

Note: If npm run dev fails, you might need to run npm run build first

Run commands

  1. Install dependencies using npm install
  2. Run npx remix init
  3. Run npm run docker
  4. Run npm run setup
  5. Run npm run build
  6. Run npm run dev

Now, navigate to localhost:3000 to see Remix App up and running: