- Website: https://neuron-book-6198.d.kiloapps.io
- Demo video: https://youtu.be/SNowMQ69PAc
This is the full-stack application featuring a Next.js frontend and a Flask backend, designed to run concurrently during development.
Before you begin, ensure you have the following installed:
- Node.js (v18 or later)
- Python (3.8 or later)
- npm (comes with Node.js)
Follow these steps to set up the project locally:
git clone https://github.com/NeuronBookAI/neuron-book.git
cd neuron-booknpm i# Move to api directory
cd api
# Create a virtual environment
python3 -m venv .venv
# Activate the environment
# On macOS/Linux:
. .venv/bin/activate
# On Windows:
# .venv\Scripts\activate
# Install Python requirements
pip install -r requirements.txt
# Return to the root directory
cd ..npm run devThe application will be available at: Frontend: http://localhost:3000 Backend API: http://localhost:5328/api
Use the following format:
- your-username/feature-name
- Example: gmatt20/neural-trace
# Create and switch to a new branch
git checkout -b your-username/feature-name
# Example
git checkout -b gmatt20/neural-tracePush your changes:
git add .
git commit -m "feat: implement socratic decay logic"
git push origin your-username/feature-nameThen create your PR in GitHub