forked from Brunastephane/MLA-pilot
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Added readme for each service - mentions prerequisites to run the service - includes instructions to run locally - points to deploy file for that service * added highlight for cucumber commands
- Loading branch information
1 parent
2c6607d
commit 3ac607e
Showing
4 changed files
with
157 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Actvity Tracking service | ||
|
||
This is the Activity Tracking microservice for the MLA Fitness tracker app. | ||
|
||
### Prerequisites | ||
|
||
- Node.js | ||
- MongoDB | ||
- npm or yarn | ||
|
||
|
||
#### Running Node.js Activity Tracker locally | ||
|
||
```sh | ||
cd activity-tracking | ||
npm install | ||
nodemon server | ||
``` | ||
|
||
#### spin up MongoDB without docker-compose: | ||
``` | ||
docker run --name mongodb -d -p 27017:27017 -v mongodbdata:/data/db mongo:latest | ||
``` | ||
|
||
### Connect to MongoDB | ||
|
||
``` | ||
mongosh -u root -p cfgmla23 --authenticationDatabase admin --host localhost --port 27017 | ||
``` | ||
|
||
show registered activities: | ||
``` | ||
db.exercises.find() | ||
``` | ||
|
||
show registered users: | ||
``` | ||
db.users.find() | ||
``` | ||
|
||
|
||
## Deployment | ||
The application is containerized using Docker and is configured for AWS deployment. A GitHub Actions pipeline is configured for CI/CD at [deploy-activity-tracking](../.github/workflows/deploy-ActivityTracking.yml) . |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Analytics service | ||
|
||
This is the Analytics microservice for the MLA Fitness tracker app. | ||
|
||
### Prerequisites | ||
|
||
- Python | ||
- Flask | ||
- MongoDB | ||
|
||
|
||
#### Running Flask application locally | ||
|
||
```sh | ||
cd analytics | ||
flask run -h localhost -p 5050 | ||
``` | ||
|
||
#### spin up MongoDB without docker-compose: | ||
``` | ||
docker run --name mongodb -d -p 27017:27017 -v mongodbdata:/data/db mongo:latest | ||
``` | ||
|
||
### Connect to MongoDB | ||
|
||
``` | ||
mongosh -u root -p cfgmla23 --authenticationDatabase admin --host localhost --port 27017 | ||
``` | ||
|
||
show registered activities: | ||
``` | ||
db.exercises.find() | ||
``` | ||
|
||
|
||
## Deployment | ||
The application is containerized using Docker and is configured for AWS deployment. A GitHub Actions pipeline is configured for CI/CD at [deploy-analytics](../.github/workflows/deploy-Analytics.yml) . |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
## Authentication service | ||
|
||
This is the Authentication microservice for the MLA Fitness tracker app. | ||
|
||
### Prerequisites | ||
|
||
- Java 8 | ||
- MongoDB | ||
- node | ||
- npm | ||
- cucumber | ||
|
||
|
||
#### Running Java application locally | ||
|
||
```sh | ||
cd authservice | ||
./gradlew clean build | ||
./gradlew bootRun | ||
``` | ||
|
||
#### spin up MongoDB without docker-compose: | ||
``` | ||
docker run --name mongodb -d -p 27017:27017 -v mongodbdata:/data/db mongo:latest | ||
``` | ||
|
||
### Connect to MongoDB | ||
|
||
``` | ||
mongosh -u root -p cfgmla23 --authenticationDatabase admin --host localhost --port 27017 | ||
``` | ||
|
||
show registered users: | ||
``` | ||
db.users.find() | ||
``` | ||
|
||
### Running Cucumber tests | ||
|
||
```sh | ||
cd authservice | ||
|
||
# check if node and npm are installed | ||
node -v | ||
npm -v | ||
|
||
# install cucumber | ||
npm install --save-dev @cucumber/cucumber | ||
|
||
# run tests | ||
npx cucumber-js | ||
|
||
``` | ||
|
||
## Deployment | ||
The application is containerized using Docker and is configured for AWS deployment. A GitHub Actions pipeline is configured for CI/CD at [deploy-authservice](../.github/workflows/deploy-AuthService.yml) . |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# MLA Fitness Tracker Frontend | ||
|
||
This is the frontend to the Activity tracker app. | ||
|
||
### Prerequisites | ||
|
||
- Node.js | ||
- npm or yarn | ||
|
||
|
||
#### Start the Frontend locally | ||
|
||
```sh | ||
cd frontend | ||
npm install | ||
npm start | ||
``` | ||
|
||
|
||
## Deployment | ||
The application is containerized using Docker and is configured for AWS deployment. A GitHub Actions pipeline is configured for CI/CD at [deploy-frontend](../.github/workflows/deploy-Frontend.yml) . |