Skip to content

Commit

Permalink
Merge pull request #211 from FINTLabs/FKS-1045-frontend-oppdater-readme
Browse files Browse the repository at this point in the history
Updated readme
  • Loading branch information
Linda-fintlabs authored Jan 24, 2025
2 parents 429b009 + 049ac55 commit e270e00
Showing 1 changed file with 35 additions and 19 deletions.
54 changes: 35 additions & 19 deletions README.md
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)

0 comments on commit e270e00

Please sign in to comment.