-
Notifications
You must be signed in to change notification settings - Fork 3
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
1 changed file
with
29 additions
and
7 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,23 +1,45 @@ | ||
## Dev environment | ||
To install the project: | ||
## Getting Started | ||
To install the project locally follow this steps: | ||
### Clone the project | ||
```bash | ||
git clone https://github.com/matias-lg/er | ||
``` | ||
### Install dependencies | ||
```bash | ||
npm install | ||
``` | ||
|
||
build the parser: | ||
### Build the ERdoc parser | ||
```bash | ||
npm run build:parser | ||
``` | ||
run the test suite: | ||
|
||
### Run the test suite: | ||
```bash | ||
npm test | ||
``` | ||
run the web app: | ||
### Start the server in dev mode: | ||
```bash | ||
npm run dev | ||
``` | ||
## Run with Docker | ||
Now you can open http://localhost:3000 and the web app should be up and running. | ||
|
||
|
||
## Run in production | ||
### Locally | ||
#### Make sure all tests pass and there's no lint errors | ||
```bash | ||
npm run test && npm run lint | ||
``` | ||
#### Build the Next.js app | ||
```bash | ||
npm run build:next | ||
``` | ||
#### Start the Node.js server | ||
``` | ||
npm run start | ||
``` | ||
|
||
### With Docker | ||
1. [Install Docker](https://docs.docker.com/get-docker/) on your machine. | ||
2. Build the container: `docker build -t er-docker .`. | ||
3. Run the container: `docker run -p 3000:3000 er-docker`. |