-
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.
Merge pull request #211 from FINTLabs/FKS-1045-frontend-oppdater-readme
Updated readme
- Loading branch information
Showing
1 changed file
with
35 additions
and
19 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,38 +1,54 @@ | ||
# Welcome to Remix! | ||
# FINT Kontroll | ||
|
||
- [Remix Docs](https://remix.run/docs) | ||
## Setup environment | ||
|
||
## Development | ||
## Create a `.env` file in root directory. | ||
|
||
From your terminal: | ||
```sh | ||
BASE_PATH=/beta/fintlabs-no | ||
PORT=3000 | ||
USER_API_URL=http://localhost:8062 | ||
ROLE_API_URL=http://localhost:8064 | ||
RESOURCE_API_URL=http://localhost:8063 | ||
ASSIGNMENT_API_URL=http://localhost:8061 | ||
ACCESS_MANAGEMENT_API_URL=http://localhost:53989 | ||
ORG_UNIT_API_URL=http://localhost:8060 | ||
LOG_LEVEL=debug | ||
CYPRESS_TESTS=false | ||
``` | ||
|
||
## Development | ||
|
||
### Start locally: | ||
1. **Start Port Forwarding** | ||
Run portall in package.json | ||
1. **Start React** | ||
Run the provided script: | ||
```sh | ||
npm run dev | ||
``` | ||
|
||
This starts your app in development mode, rebuilding assets on file changes. | ||
A bearer token is necessary for local connection to backend. | ||
|
||
## Deployment | ||
## Testing | ||
|
||
First, build your app for production: | ||
### Run tests | ||
|
||
```sh | ||
npm run build | ||
```bash | ||
cypress run | ||
``` | ||
|
||
Then run the app in production mode: | ||
|
||
```sh | ||
npm start | ||
Open tests in browser: | ||
```bash | ||
cypress open | ||
``` | ||
|
||
Now you'll need to pick a host to deploy it to. | ||
## Styling | ||
|
||
### DIY | ||
Tailwind, Aksel, and Novari-theme | ||
|
||
If you're familiar with deploying node applications, the built-in Remix app server is production-ready. | ||
## Deployment | ||
|
||
Make sure to deploy the output of `remix build` | ||
Maunual deploy on github | ||
|
||
- `build/` | ||
- `public/build/` | ||
- [Remix Docs](https://remix.run/docs) |