Welcome! This is the repository for the website frontend of the xCurator.
- General: React, Next.js, TypeScript
- Styling: TailwindCSS, Headless UI, heroicons
- Forms: React Hook Form, yup
- Global state: zustand
Cheers to all of these projects!
- Node.js v14+
- Run
npm i
in the root directory to install all packages - Make sure
.env.development
fits your needs - if it doesn’t, create a copy called.env.development.local
and change any values as you see fit - Run
npm run dev
to start the next.js development server- It supports hot reloading - no need to restart the development server for code changes
- You will need to restart it e.g. for changes to the .env though
- It supports hot reloading - no need to restart the development server for code changes
- Please use a code formatter before committing.
- I run Prettier automatically on each save
- TODO: We should add a pre-commit hook for this at some point
In case you encounter any problems or you have any questions, please raise an issue here on Github.