An Astro based front-end to interact with the ResearchEquals API.
Find a file
2025-09-26 16:07:32 +02:00
.vscode Initial commit from Astro 2025-08-25 11:00:40 +02:00
public Initial commit from Astro 2025-08-25 11:00:40 +02:00
src chore(ui): refactor page header into consistent component 2025-09-26 16:07:32 +02:00
.gitignore Initial commit from Astro 2025-08-25 11:00:40 +02:00
astro.config.mjs feat(core): add localization 2025-08-25 11:48:40 +02:00
LICENSE chore(dx): update repo docs 2025-08-25 11:09:04 +02:00
package-lock.json init blocknote 2025-09-25 16:26:02 +02:00
package.json init blocknote 2025-09-25 16:26:02 +02:00
README.md chore(dx): update repo docs 2025-08-25 11:09:04 +02:00
tsconfig.json chore(core): add react support 2025-08-25 11:03:34 +02:00

ResearchEquals website

Conventional Commits SemVer NIX

Welcome to the repository for the ResearchEquals website! 👋 We build this front-end with priority for accessibility, reliability, and performance.

The front-end relies on the ResearchEquals API. If you are copying the code from this repository, you need to set up a separate ResearchEquals API yourself. In the future, we will add a docker image that will do both for you.

🚀 Project Structure

Inside of our Astro project, you'll see the following folders and files:

/
├── public/
├── src/
│   └── pages/
│       └── index.astro
└── package.json

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Any static assets, like images, can be placed in the public/ directory.

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command Action
npm install Installs dependencies
npm run dev Starts local dev server at localhost:4321
npm run build Build your production site to ./dist/
npm run preview Preview your build locally, before deploying
npm run astro ... Run CLI commands like astro add, astro check
npm run astro -- --help Get help using the Astro CLI

👀 Want to learn more?

Feel free to check our documentation or jump into our Discord server.