If you only want to tinker around with the client, you will only need the client
folder. This will use the project's server as the backend.
If you want to deploy your own model, you can either train your own model (see the instructions in the model
) or download the pre-trained checkpoint from here. Once you have deployed the server, change the server address inside client\src\api.ts
.
- Install node.js LTS.
- Navigate to the client folder and run
npm install
to install the dependencies. - Run
npm run serve
to develop ornpm run build
to build a distributable.
By default, this uses the project's server as the backend. You can also train your own model and deploy your own server.
See the model folder for details. Once you have trained your model, put the checkpoint in the checkpoints
folder.
See the server folder for details. You can use the provided Dockerfile. Don't forget to change the API url in the client.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
- 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