Answerbook UI (Frontend)

This repo contains the frontend code for the Answerbook project. The frontend is a React app that uses the Radix UI library for styling & component primitives.

Setup

1. Run nvm use to ensure you're using the correct Node version.
2. Run npm install to install dependencies (this will also setup commit hooks).
3. Make a copy of .env.template as .env and fill it in. This file is used to store environment variables, specifically the API keys needed to use mathpix for handwriting recognition.

Running the application

In Docker

With Docker-based postgres (recommended)

1. For first run, do: docker compose -f dev.docker-compose.yml up --build
2. After, use: docker compose -f dev.docker-compose.yml up

With a local copy of Postgres

1. For first run, do: docker compose -f dev.local.docker-compose.yml up --build
2. After, use: docker compose -f dev.local.docker-compose.yml up

For either, you might also want to pass in -d to run in detached mode.

After startup

1. Setup the database: docker exec $(docker ps -qf "name=answerbook-ui-backend" | head -n1) poetry run alembic upgrade head

Old README: Getting Started with Create React App

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.