To install the project, you need to have Node.js and npm (or yarn) installed on your machine. Then, you can clone the repository and install the dependencies:
git clone https://github.com/yourusername/toolkit.git
cd toolkit
npm install
To start the server, run:
npm run start
The server will start on http://localhost:3000
.
If you want to contribute to the project, here's how you can do it:
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
The project uses vitest
npm run test
This project uses Next.js's built-in ESLint support for linting. To run linting, use:
npm run lint
To build the application for production, use:
npm run build
The middleware is responsible for handling requests and responses. You can find the middleware code in src/middleware.ts
.
The project uses React hooks for managing state and side effects. You can find the hooks in src/hooks
.
The UI components are built with React. You can find the components in src/components
.
Database is managed by Supabase: DB management https://supabase.com/dashboard/project/ivyetfewzyvpkmjdtyiy
To run a supabase DB instance locally, first install docker.
brew install supabase/tap/supabase
Then you'll need to install the supabase CLI and run
# If you've never initialized supabase:
supabase init
# This will setup the supabase docker container and start the database:
supabase start
To get the local studio url, run:
supabase status
This project is licensed under the MIT License.