Skip to content

Commit

Permalink
improved README
Browse files Browse the repository at this point in the history
  • Loading branch information
Sebastian Reck committed Mar 29, 2024
1 parent bab8040 commit f2ba7ce
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,49 @@
# 2a5-app

See 2a5-api first

Docker container are running

2a5-api-development 3000
2a5-db-development 5432




# Development
You need to install on your local workstation:
- git
- nodejs
- npm
- docker

Clone the repository:
```bash
git clone https://github.com/reckseba/2a5-app.git
```

Install your environment
```bash
cd 2a5-app
npm install
```

Run the nodejs development server:
```bash
npm run dev
```

Start coding and open [http://localhost:3001](http://localhost:3001) with your browser of choice to check the result. The system supports hot reload.


Stop it with CTRL+C




# Cleanup locally

Delete all generated files
```bash
rm -rf .next/ node_modules/ next-env.d.ts
```

0 comments on commit f2ba7ce

Please sign in to comment.