This is a Next.js project bootstrapped with create-next-app.
First, install the requirements:
npm i --dev
npm run install:assetsThen, run the development server:
npm run devOpen http://localhost:4080/bichard with your browser to see the Bichard7 UI. Database and a valid auth token is required to be able to browse the service locally.
To spin up a local instance of the database, user-service and auth proxy, you can use the following npm run ui command in the bichard7-next-core:
$ cd /path/to/bichard7-next-core
$ npm run uiOnce the dependencies have run follow these login instruction:
- Navigate to the User Service at https://localhost:4443/users/ and sign in:
User: e.g bichard01@example.com, Pass: password You can grab the 2fa code out of the local Bichard database on the users table under the
email_verification_codecolumn - After signing in, you should see the User Service home page. An
.AUTHcookie is generated for localhost, so now you can access Bichard7 UI on http://localhost:4080/bichard
| Directory | Purpose |
|---|---|
| components | Generic reusable components which can be used anywhere within our application |
| features | Non-generic components which relate to one or more pages |
| pages | Each top-level next.js page which can be visited |
| types | Shared types for typescripting |
| middleware | Code run by our next.js while rendering our pages |
| services | Data access and transformations |
To run the tests, ensure that you have a local postgres instance running (run npm run ui from the bichard7-next-core repo),
then run npm run test in this repo
To run code-based (non-visual, no components get rendered) unit tests, run
npm run test:unitCode-based integration tests to be run alongside the bichard7-next postgres instance
npm run test:integrationBrowser-based E2E cypress tests to be run alongside:
To run the cypress tests against this, run:
npm run cypress:open:dockeror if you're running the UI locally (npm run dev - will require you to kill the UI docker container first):
npm run cypress:open