eastwood/ethermap
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

updated README to reflect setup changes

Browse Source
This commit is contained in:
suroh 2023-09-14 14:09:07 +02:00
parent 75e5200748
commit 765326cfdd
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -10,23 +10,21 @@ Ethermap is built in JavaScript (soz) using NodeJS. To install you can do so by
To install all dependencies for the front and backend : To install all dependencies for the front and backend :
```sh ```sh
$ npm run install:all $ npm run install
``` ```
You will then need to create a `.env` file in the root of the backend. There is a `.env.template` that you can copy as a guide. For a dev server you can simply copy and paste the template leaving it as is. You will then need to create a `.env` file in the root folder. There is a `.env.template` that you can copy as a guide. For a dev server you can simply copy and paste the template leaving it as is.
Then migrate the database structure : Then migrate the database structure :
```sh ```sh
$ npm run migrate:latest $ npm run migrate:latest
``` ```
Then you should be able to run the dev servers : Then you should be able to run the dev server :
```sh ```sh
$ npm run dev:all $ npm run dev
``` ```
> NOTE : while you can change the server port number, the front end is hardwired to make requests on port 3000, so for now don't change this. You should now be able to access ethermaps on [`http://localhost:3000`](http://localhost:3000/) (or whichever port you configured in your `.env` file).
The backend is running on the port that you defined in your `.env` file (by default it is port 3000), and the frontend will be running on the default Vite port `5173`.
## Desires ## Desires