__ABOUT
- 🪧 About
- 📦 Prerequisites
- 🚀 Installation
- 🛠️ Usage
- 🤝 Contribution
- 🏗️ Built with
- 📝 License
Node can be installed via nvm, which allows you to quickly get and use different versions of Node via the command line.
Clone the project
npm install
These commands are used in the context of application development and should be run from the root of the workspace.
npm run build
npm run start-local
Common development commands are found in the scripts field of package.json The API relies on a PostgreSQL database service which can be set up locally on docker.
Docker one-liner To set up a blank database for testing
docker run -d \
--name postgres \
--rm \
--shm-size=512m \
-p 5432:5432 \
-e POSTGRES_DB=database \
-e POSTGRES_USER=postgres \
-e POSTGRES_PASSWORD=password \
-v "$(pwd)/docker-data/postgresql:/var/lib/postgresql/data" \
postgres:14.6
Testing
❯ curl http://0.0.0.0:3000 1.64 14,6G 0,B 100%
OK
Without a database
Copy code
❯ curl http://0.0.0.0:3000/database-status 1.60 14,6G 0,B 100%
{"statusCode":500,"code":"ECONNREFUSED","error":"Internal Server Error","message":"connect ECONNREFUSED 127.0.0.1:5432"}%
With a blank database
Copy code
❯ curl http://0.0.0.0:3000/database-status 1.18 14,8G 0,B 100%
{"databaseSize":{"pg_size_pretty":"8553 kB"},"numberOfConnexions":{"count":"1"},"numberOfActiveConnexions":{"count":"1"},"listOfAllPublicTables":"[]"}%
The project is currently not open to contributions.
Github Actions is the integrated Continuous Integration and Deployment tool in GitHub
The deployment history is available under the Actions tab
-
Repository Secrets:
AWS_ACCESS_KEY_ID
: The ID of the key for the programmatic account that allows pushing the container image onto ECR- Provisioned by the organization deployer of the parent AWS organization account
AWS_SECRET_ACCESS_KEY
: The secret key of the programmatic account that allows pushing the container image onto ECR- Provisioned by the organization deployer of the parent AWS organization account
-
AWS is the Cloud services platform offered by Amazon.
- User:
__PROJECT.api.ci
- Group:
api.deployer
- User:
-
ECR Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service by AWS.
See the LICENSE.md file in the repository.