Neroli's Lab helps users make informed decisions regarding their investments in Pokémon Sleep. We provide tooling such as production calculators, optimal team composition algorithms, and simulation-based cooking tier lists.

🚀 Quick Links

• Live Website - Try our tools and calculators
• Discord Community - Get help and discuss
• 📚 Documentation - Getting started guides, architecture, and technical specifications

🤝 Contribute

Want to contribute? You can find out how to get started on our documentation page:

🔗 docs.nerolislab.com →

📦 Build And Run Dependencies

To build and run the app locally, you will need:

• Node.js and npm
• Bun
• Docker with Compose support for the backend database
• We recommend using nvm to install and select the repo's Node.js version for non-Nix setups

❄️ Optional Nix Dev Shell

This option is community-maintained and is not officially supported by the core dev team.

If you use Nix, this repo includes an optional dev shell:

nix develop

The dev shell provides node, npm, and bun. Docker is still expected to be installed and available on your system outside the dev shell.

🛠️ Quick Start

If you want to get the project running locally, follow these docs in order:

1. Start with Development Setup: prerequisites, workspace setup, and the shape of the project.
2. Build the shared library using instructions from Common Library.
3. Set up the local database and backend environment following Backend.
4. Start the frontend with Frontend.

📄 License

Released under the Apache 2.0 License.

---