forked from cerc-io/snowballtools-base
a4d9211ffe
This pull request refactors the main `README.md` by removing detailed backend and frontend setup instructions and adding separate `README.md` files for the backend and frontend with their specific setup and deployment instructions. This makes the main `README.md` cleaner and directs users to specific READMEs for backend and frontend setups. --- |
||
|---|---|---|
| .. | ||
| environments | ||
| src | ||
| test | ||
| .eslintignore | ||
| .eslintrc.json | ||
| .gitignore | ||
| .node-version | ||
| .prettierignore | ||
| .prettierrc.json | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
backend
This backend is a node.js express.js apollo server project in a yarn workspace.
Getting Started
Install dependencies
In the root of the project, run:
yarn
Build backend
yarn build --ignore-frontend
Environment variables
Local
Copy the envionments/local.toml.example file to envionments/local.toml:
cp envionments/local.toml.example envionments/local.toml
Staging environment variables
In the deployment repository, update staging staging/configmaps/config/prod.toml
Production environment variables
In the deployment repository, update production production/configmaps/config/prod.toml
Run development server
yarn start
Deployment
Clone the deployer repository:
git clone git@git.vdb.to:cerc-io/snowballtools-base-api-deployments.git
Staging
echo trigger >> .gitea/workflows/triggers/staging-deploy
git commit -a -m "Deploy v0.0.8" # replace with version number
git push
Production
echo trigger >> .gitea/workflows/triggers/production-deploy
git commit -a -m "Deploy v0.0.8" # replace with version number
git push
Deployment status
Dumb for now
Update version number manually in routes/staging.ts