Optimizing the founding process for startups in Germany
- Node v16 or later (check version using
node -v) - Docker v20 or later & Docker Compose (check using
docker -v)
- Install initial dependencies using
npm i - Install nested dependencies and link apps and packages together using
npm run bootstrap - To get firebase in the backend working, you'll need a firebase service account key. You can either get it yourself following this guide if you have access to the firebase project, or ask in slack for it
- Put the firebase.json file in the
apps/backendfolder
You can start the frontend and backend individually using npm run start:fe and npm run start:be or at the same time using npm start
There are some Visual Studio Code Extensions that are not needed but are pretty useful for working with this project:
.
├─ apps # Everything that is a standalone application
│ ├─ frontend # Main frontend for Venture Capitol
│ ├─ backend # Main Backend for Venture Capitol
│ └─ utr-backend # Backend for the Company Register of Venture Capitol
├─ packages # Shared Code and libraries
│ └─ common # Shared GraphQl API definition
├─ Dockerfile.* # Dockerfiles used for deployment
└─ README.md # This file :)
Installing a dependency has to be done through lerna using npx lerna add <package> --scope @vc/<app>
Use firebase deploy to deploy to firebase. To change to environment to which firebase deploys, make a change in the line containing "site": "preview-vc", changing the end to either preview-vc or venture-capitol.
Ports reserved for each service, all interchangeable by setting the PORT environment variable.
| service | port |
|---|---|
| frontend | 8100 |
| backend | 8101 |
| utr-backend | 8103 |
| storybook | 8104 |
| database | 5432 |
| utr-database | 5433 |
On Windows: kill ports with npm run kill