mirror of
https://github.com/bluewave-labs/Checkmate.git
synced 2025-03-14 10:33:19 +00:00
Installation documents are now on Gitbook.
This commit is contained in:
Gorkem Cetin (BWL)
committed by
GitHub
GitHub
parent
acc673c244
commit
211a1a2711
218
README.md
218
README.md
@ -21,7 +21,11 @@ See [BlueWave Uptime](https://uptime-demo.bluewavelabs.ca/) in action. The usern
|
||||
|
||||
## User's guide
|
||||
|
||||
Installation and usage instructions can be found [here](https://bluewavelabs.gitbook.io/uptime-manager).
|
||||
Usage instructions can be found [here](https://bluewavelabs.gitbook.io/uptime-manager).
|
||||
|
||||
## Installation
|
||||
|
||||
See installation instructions in [Uptime Manager documentation portal](https://bluewavelabs.gitbook.io/uptime-manager/quickstart).
|
||||
|
||||
## Questions & ideas
|
||||
|
||||
@ -82,215 +86,3 @@ Also check other developer and contributor-friendly projects of BlueWave:
|
||||
- [BlueWave DataRoom](https://github.com/bluewave-labs/bluewave-dataroom)
|
||||
- [VerifyWise](https://github.com/bluewave-labs/verifywise)
|
||||
|
||||
## Getting Started
|
||||
|
||||
- Clone this repository to your local machine
|
||||
|
||||
1. [Quickstart for Users](#user-quickstart)
|
||||
2. [Quickstart for Developers](#dev-quickstart)
|
||||
3. [Manual Install](#manual-install)
|
||||
|
||||
- [Install Client](#install-client)
|
||||
- [Environment](#env-vars-client)
|
||||
- [Start Client](#start-client)
|
||||
- [Install Server](#install-server)
|
||||
- [Environment](#env-vars-server)
|
||||
- [Database](#databases)
|
||||
- [(Optional) Dockerised Databases](#optional-docker-databases)
|
||||
- [Start Server](#start-server)
|
||||
|
||||
4. [API Documentation](#api-documentation)
|
||||
5. [Error Handling](#error-handling)
|
||||
6. [Contributors](#contributors)
|
||||
|
||||
---
|
||||
|
||||
## <u> Quickstart for Users</u><a id="user-quickstart"></a>
|
||||
|
||||
1. Download our [Docker Compose File](/Docker/dist/docker-compose.yaml)
|
||||
2. Run `docker compose up` to start the application
|
||||
3. Application is running at `http://localhost`
|
||||
|
||||
## <u>Quickstart for Developers</u> <a id="dev-quickstart"></a>
|
||||
|
||||
<span style="color: red; font-weight: bold;">MAKE SURE YOU CD TO THE SPECIFIED DIRECTORIES AS PATHS IN COMMANDS ARE RELATIVE</span>
|
||||
|
||||
### Cloning and Initial Setup
|
||||
|
||||
1. Clone this repository
|
||||
2. Checkout the `develop` branch `git checkout develop`
|
||||
|
||||
### Docker Images Setup
|
||||
|
||||
3. <span style="color: red; font-weight: bold;">CD</span> to the `Docker/dev` directory
|
||||
4. Run `docker run -d -p 6379:6379 -v $(pwd)/redis/data:/data --name uptime_redis uptime_redis`
|
||||
5. Run `docker run -d -p 27017:27017 -v $(pwd)/mongo/data:/data/db --name uptime_database_mongo uptime_database_mongo`
|
||||
|
||||
### Server Setup
|
||||
|
||||
6. <span style="color: red; font-weight: bold;">CD</span> to `Server` directory, run `npm install`
|
||||
7. While in `Server` directory, create a `.env` file with the [required environmental variables](#env-vars-server)
|
||||
8. While in the `Server` directory, run `npm run dev`
|
||||
|
||||
### Client Setup
|
||||
|
||||
9. <span style="color: red; font-weight: bold;">CD</span> to `Client` directory `run npm install`
|
||||
10. While in the `Client` directory, create a `.env` file with the [required environmental variables](#env-vars-client)
|
||||
11. While in the `Client` cirectory run `npm run dev`
|
||||
|
||||
### Access Application
|
||||
|
||||
12. Client is running at `localhost:5173`
|
||||
13. Server is running at `localhost:5000`
|
||||
|
||||
---
|
||||
|
||||
## <u>Manual Install</u> <a id="manual-install"></a>
|
||||
|
||||
---
|
||||
|
||||
### Client Installation<a id="install-client"></a>
|
||||
|
||||
1. Change directory to the `Client` directory
|
||||
2. Install all dependencies by running `npm install`
|
||||
|
||||
---
|
||||
|
||||
### Environmental Variables <a id="env-vars-client"></a>
|
||||
|
||||
| ENV Variable Name | Required/Optional | Type | Description | Accepted Values |
|
||||
| --------------------- | ----------------- | --------- | ------------------ | ---------------------------------- |
|
||||
| VITE_APP_API_BASE_URL | Required | `string` | Base URL of server | {host}/api/v1 |
|
||||
| VITE_APP_LOG_LEVEL | Optional | `string` | Log level | `"none"`\|`"error"` \| `"warn"` \| |
|
||||
| VITE_APP_DEMO | Optional | `boolean` | Demo server or not | `true`\|`false` \| |
|
||||
|
||||
---
|
||||
|
||||
### Starting Development Server<a id="start-client"></a>
|
||||
|
||||
1. Run `npm run dev` to start the development server.
|
||||
|
||||
---
|
||||
|
||||
### Server Installation<a id="install-server"></a>
|
||||
|
||||
1. Change directory to the `Server` directory
|
||||
2. Install all dependencies by running `npm install`
|
||||
|
||||
---
|
||||
|
||||
### Environmental Variables <a id="env-vars-server"></a>
|
||||
|
||||
Configure the server with the following environmental variables:
|
||||
|
||||
| ENV Variable Name | Required/Optional | Type | Description | Accepted Values |
|
||||
| --------------------- | ----------------- | --------- | ---------------------------------------- | ------------------------------------------------ |
|
||||
| CLIENT_HOST | Required | `string` | Frontend Host | |
|
||||
| JWT_SECRET | Required | `string` | JWT secret | |
|
||||
| DB_TYPE | Optional | `string` | Specify DB to use | `MongoDB \| FakeDB` |
|
||||
| DB_CONNECTION_STRING | Required | `string` | Specifies URL for MongoDB Database | |
|
||||
| PORT | Optional | `integer` | Specifies Port for Server | |
|
||||
| LOGIN_PAGE_URL | Required | `string` | Login url to be used in emailing service | |
|
||||
| REDIS_HOST | Required | `string` | Host address for Redis database | |
|
||||
| REDIS_PORT | Required | `integer` | Port for Redis database | |
|
||||
| TOKEN_TTL | Optional | `string` | Time for token to live | In vercel/ms format https://github.com/vercel/ms |
|
||||
| PAGESPEED_API_KEY | Optional | `string` | API Key for PageSpeed requests | |
|
||||
| SYSTEM_EMAIL_HOST | Required | `string` | Host to send System Emails From | |
|
||||
| SYSTEM_EMAIL_PORT | Required | `number` | Port for System Email Host | |
|
||||
| SYSTEM_EMAIL_ADDRESS | Required | `string` | System Email Address | |
|
||||
| SYSTEM_EMAIL_PASSWORD | Required | `string` | System Email Password | |
|
||||
|
||||
---
|
||||
|
||||
### Databases <a id="databases"></a>
|
||||
|
||||
This project requires two databases:
|
||||
|
||||
1. **Main Application Database:** The project uses MongoDB for its primary database, with a MongoDB Docker image provided for easy setup.
|
||||
2. **Redis for Queue Management:** A Redis database is used for the PingService’s queue system, and a Redis Docker image is included for deployment.
|
||||
|
||||
You may use the included Dockerfiles to spin up databases quickly if you wish.
|
||||
|
||||
#### (Optional) Dockerised Databases <a id="optional-docker-databases"></a>
|
||||
|
||||
Dockerfiles for the server and databases are located in the `Docker` directory
|
||||
|
||||
<details>
|
||||
<summary><b>MongoDB Image</b></summary>
|
||||
|
||||
Location: `Docker/mongoDB.Dockerfile`
|
||||
|
||||
The `Docker/mongo/data` directory should be mounted to the MongoDB container in order to persist data.
|
||||
|
||||
From the `Docker` directory run
|
||||
|
||||
1. Build the image: `docker build -f mongoDB.Dockerfile -t uptime_database_mongo .`
|
||||
2. Run the docker image: `docker run -d -p 27017:27017 -v $(pwd)/mongo/data:/data/db --name uptime_database_mongo uptime_database_mongo`
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary><b>Redis Image</b></summary>
|
||||
|
||||
Location `Docker/redis.Dockerfile`
|
||||
|
||||
the `Docker/redis/data` directory should be mounted to the Redis container in order to persist data.
|
||||
|
||||
From the `Docker` directory run
|
||||
|
||||
1. Build the image: `docker build -f redis.Dockerfile -t uptime_redis .`
|
||||
2. Run the image: `docker run -d -p 6379:6379 -v $(pwd)/redis/data:/data --name uptime_redis uptime_redis`
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
### Starting the Development Server <a id="start-server"></a>
|
||||
|
||||
- run `npm run dev` to start the development server
|
||||
|
||||
OR
|
||||
|
||||
- run `node index.js` to start server
|
||||
|
||||
---
|
||||
|
||||
## <u>API Documentation</u><a id="api-documentation"></a>
|
||||
|
||||
Our API is documented in accordance with the [OpenAPI spec](https://www.openapis.org/).
|
||||
|
||||
You can see the documentation on your local development server at [http://localhost:{port}/api-docs](htt>>p://localhost:5000/api-docs)
|
||||
|
||||
You can also view the documentation on our demo server at [https://uptime-demo.bluewavelabs.ca/api-docs](https://uptime-demo.bluewavelabs.ca/api-docs)
|
||||
|
||||
## <u>Error handling</u>
|
||||
|
||||
Errors are returned in a standard format:
|
||||
|
||||
`{"success": false, "msg": "No token provided"}`
|
||||
|
||||
Errors are handled by error handling middleware and should be thrown with the following parameters
|
||||
|
||||
| Name | Type | Default | Notes |
|
||||
| ------- | --------- | ---------------------- | ------------------------------------ |
|
||||
| status | `integer` | 500 | Standard HTTP codes |
|
||||
| message | `string` | "Something went wrong" | An error message |
|
||||
| service | `string` | "Unknown Service" | Name of service that threw the error |
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
const myRoute = async(req, res, next) => {
|
||||
try{
|
||||
const result = myRiskyOperationHere();
|
||||
}
|
||||
catch(error){
|
||||
error.status = 404
|
||||
error.message = "Resource not found"
|
||||
error.service = service name
|
||||
next(error)
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
Errors should not be handled at the controller level and should be left to the middleware to handle.
|
||||
|
||||
Reference in New Issue
Block a user