Skip to content

Commit f99ddf0

Browse files
committed
docs: add infra documentation
1 parent 37b10c5 commit f99ddf0

File tree

1 file changed

+33
-2
lines changed

1 file changed

+33
-2
lines changed

README.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,33 @@
1-
# openjs-foundation
2-
Secure Dashboard for the OpenJS Foundation
1+
# Secure Dashboard for the OpenJS Foundation
2+
3+
This is an evolution of [this proof of concept (POC)](https://github.com/UlisesGascon/poc-openjs-security-program-standards-dashboard).
4+
5+
## Prerequisites
6+
7+
- Node.js 22 and npm
8+
- Docker and Docker Compose
9+
10+
## Infrastructure
11+
12+
This project requires a PostgreSQL database. You can run this project using a local database with Docker. Additionally, this project provides an instance of [Adminer](https://www.adminer.org/) accessible at `http://localhost:8080`.
13+
14+
15+
### Starting the Infrastructure
16+
17+
To start the infrastructure, run the following command:
18+
19+
```bash
20+
npm run infra:start
21+
```
22+
23+
### Stopping the Infrastructure
24+
25+
To stop the infrastructure, run the following command:
26+
27+
```bash
28+
npm run infra:stop
29+
```
30+
31+
## License
32+
33+
This project is licensed under the MIT License. See the [LICENSE](/LICENSE) file for details.

0 commit comments

Comments
 (0)