Skip to content

Commit

Permalink
updated readme's
Browse files Browse the repository at this point in the history
  • Loading branch information
20Alexanderxx committed Jul 10, 2023
1 parent 0edce52 commit e70b6f3
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Map


run it with `npm run dev`

Map Preview:

Expand Down
10 changes: 7 additions & 3 deletions backend/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
# Node Backend

``❗ Please place a keycloak.json inside the root folder of the project. See the example here: https://github.com/keycloak/keycloak-quickstarts/blob/latest/service-nodejs/keycloak.json``
`❗ Please place a keycloak.json inside the root folder of the project. See the example here: https://github.com/keycloak/keycloak-quickstarts/blob/latest/service-nodejs/keycloak.json`

# Start Developing

#### If you are using JetBrains WebStorm, look below under `Start Developing in WebStorm`

1. Clone this Repository (`git clone https://github.com/BTE-Germany/map.git`)
2. Compile the TS files to JS (`tsc` if not installed, run `npm install -g typescript`)
3. Start the server with `npm start`
4. 🎉 Start Coding
4. Make sure that the database in the backend is running
5. 🎉 Start Coding

📌 All settings can be made in a `.env` file. (Just copy and rename the `.example.env`)
Update DB: make change in schema.prisma and run prisma db push

📌 All settings can be made in a `.env` file. (Just copy and rename the `.example.env`)

# Start Developing in WebStorm

1. Clone this Repository (`git clone https://github.com/BTE-Germany/map.git`)
2. Open your WebStorm settings (CTRL+ALT+S)
3. Enable the following checkbox ![](https://i.arvserver.xyz/webstorm64_S0SyJU6BhQ.png)
Expand Down

0 comments on commit e70b6f3

Please sign in to comment.