-
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.
- Loading branch information
Showing
2 changed files
with
20 additions
and
21 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 |
---|---|---|
@@ -1,19 +1,16 @@ | ||
# Deployment of the dashboard | ||
# Dashboard deployment | ||
|
||
## 1. Select a Deployment Platform | ||
The dashboard is a simple React Vite application so it should | ||
be straightforward to deploy. | ||
|
||
Choose a platform that best fits your needs for deploying the dashboard, | ||
ensuring it aligns with your performance, scalability, and budget requirements. | ||
## Cloudflare Pages | ||
|
||
## 2. Set Up CI/CD | ||
|
||
To streamline development, implement a Continuous Integration/Continuous Deployment (CI/CD) pipeline. This will automate testing and deployment, | ||
allowing you to focus on building features and improving the dashboard without manual deployment steps. | ||
|
||
## 3. Or... just deploy on Cloudflare | ||
|
||
With the help of GitHub Actions, the deployment is mostly automated. Ensure you have the following in place: | ||
With the help of GitHub Actions, the deployment is mostly automated. | ||
Ensure you have the following in place: | ||
|
||
1. **Set up GitHub Secrets:** Add your `CLOUDFLARE_API_TOKEN` and `CLOUDFLARE_ACCOUNT_ID` in your GitHub repository secrets. | ||
|
||
2. **Verify the GitHub Actions Workflow:** Ensure the workflow file is properly configured to build and deploy the application. The configuration is in | ||
`/dashboard/.github/workflows/cloudflare-deploy.yml` | ||
`.github/workflows/cloudflare-deploy.yml` | ||
|
||
Deployed at <https://burrito-dashboard.pages.dev/> |
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 |
---|---|---|
@@ -1,11 +1,13 @@ | ||
# Before Using or Sharing the Dasboard | ||
# Additional notes | ||
|
||
## 1. Create a User in the Database | ||
Before deploying the dashboard, make sure to: | ||
|
||
Ensure that a user account with the appropriate permissions is created in the database. This allows access control and ensures that each user can interact | ||
with the dashboard as expected. | ||
- Ensure that a user account with the appropriate permissions | ||
is created in the database. This allows access control and | ||
ensures that each user can interact with the dashboard as | ||
expected. | ||
|
||
## 2. The server must be running | ||
|
||
Verify that the backend server is running and accessible. The dashboard relies | ||
on the server for data retrieval and updates, so a live connection is essential for full functionality. | ||
- Verify that the backend server is running and accessible. | ||
The dashboard relies on the server for data retrieval | ||
and updates, so a live connection is essential for full | ||
functionality. |