page_type | languages | products | description | urlFragment | ||
---|---|---|---|---|---|---|
sample |
|
|
This code is part of the Skill Me Up AKS operations challenge. It provides the API for the ratings application. The API connects to a MongoDB to store and retrieve data. |
aksworkshop-ratings-api |
This code is part of the Skill Me Up AKS operations challenge. It provides the API for the ratings application. The API connects to a MongoDB to store and retrieve data.
File/folder | Description |
---|---|
routes |
API endpoint implementation. |
models |
Representation of API data model. |
data |
Data to be preloaded into the database. |
views |
Handelbars HTML view templates. |
server.js |
NodeJS web server startup file. |
app.js |
Express NodeJS application startup file. |
.gitignore |
Define what to ignore at commit time. |
.dockerignore |
Define what to ignore at build time. |
Dockerfile |
Define how the Docker image is built. |
README.md |
This README file. |
LICENSE |
The license for the sample. |
To build this sample locally, you can either build using Docker, or using NPM.
- To build using Docker, in the project folder, run
docker build -t ratings-api .
- To build using NPM, in the project folder, run
npm install
- To run using Docker, run
docker run -it -p 3000:3000 ratings-api
- To run using NPM, run
npm start
Required configuration via environment variables:
- MONGODB_URI: MongoDB connection is configured using an environment variable called
MONGODB_URI
. This URI should look likemongodb://[username]:[password]@[endpoint]:27017/ratingsdb
The API exposes port 3000.
You should then be able to access the API at http://localhost:3000/api/items