-
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.
feat(docker): add fullstack docker setup
Signed-off-by: Charles Madjeri <[email protected]>
- Loading branch information
Charles Madjeri
committed
Dec 5, 2024
1 parent
e749213
commit 4243b5e
Showing
16 changed files
with
209 additions
and
97 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 +1,8 @@ | ||
VITE_PORT=8081 | ||
VITE_PORT=8081 | ||
|
||
# Server database environment variables | ||
DB_NAME=area | ||
DB_PASSWORD=change-me | ||
DB_HOST=mariadb | ||
DB_PORT=3306 | ||
DB_USER=root |
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 |
---|---|---|
|
@@ -136,3 +136,5 @@ dist | |
.yarn/build-state.yml | ||
.yarn/install-state.gz | ||
.pnp.* | ||
|
||
ssl/ |
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
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 |
---|---|---|
|
@@ -6,11 +6,11 @@ With AREA, you can create automated workflows that integrate various services an | |
## Table of Contents | ||
|
||
- [Getting Started](#getting-started) | ||
- [Prerequisites](#prerequisites) | ||
- [Installation & Usage](#installation--usage) | ||
- [Prerequisites](#prerequisites) | ||
- [Installation & Usage](#installation--usage) | ||
- [Documentation](#documentation) | ||
- [Requirements](#requirements) | ||
- [Usage](#usage) | ||
- [Requirements](#requirements) | ||
- [Usage](#usage) | ||
- [Tests](#tests) | ||
- [License](#license) | ||
- [Contributors](#contributors) | ||
|
@@ -19,50 +19,39 @@ With AREA, you can create automated workflows that integrate various services an | |
|
||
### Prerequisites | ||
|
||
- vite js | ||
- go | ||
- docker | ||
- make | ||
|
||
### Installation & Usage | ||
|
||
<details> | ||
<summary>Click to expand</summary> | ||
|
||
1. Clone the repo | ||
|
||
```sh | ||
git clone [email protected]:ASM-Studios/AREA.git | ||
``` | ||
|
||
2. Create .env files | ||
|
||
- Run the following command to create private env files | ||
|
||
```sh | ||
cp .env.example .env | ||
cp server/.env.server.example server/.env.server | ||
cp client_web/.env.local.example .env.local | ||
cp client_mobile/.env.mobile.example .env.mobile | ||
``` | ||
|
||
- Fill the .env, .env.web and .env.mobile files | ||
|
||
3. Install NPM packages | ||
```sh | ||
cd AREA/client-web | ||
npm install | ||
``` | ||
4. Run the project | ||
|
||
3. Install Go packages | ||
```sh | ||
cd AREA/server | ||
<TODO> | ||
make start | ||
``` | ||
|
||
4. Run the project | ||
```sh | ||
cd AREA/client-web | ||
npm run start | ||
``` | ||
```sh | ||
cd AREA/server | ||
go run ./... | ||
``` | ||
</details> | ||
|
||
### Documentation | ||
|
@@ -87,6 +76,7 @@ The documentation is automatically built and deployed to GitHub Pages when a pus | |
You can consult the documentation online at [AREA Documentation](https://asm-studios.github.io/AREA/). | ||
|
||
You can build the documentation locally by running the following command: | ||
|
||
```sh | ||
cd AREA/docs | ||
make docs | ||
|
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
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
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
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
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
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
Oops, something went wrong.