Start here
Where the code lives
A beginner-friendly map of the folders and the first file to open.
The six folders and files to know
A repository is the folder that holds the whole project. Start with these six places:
| Place | What you will find there |
|---|---|
src/ | The app itself. This is where most features are built. |
db/migrations/ | Step-by-step instructions for changing the database safely. |
test/ | Automatic checks that prove important behaviour still works. |
scripts/ | Small tools developers run for jobs such as setup, checks, and repairs. |
docs/ | Longer guides, product decisions, safety rules, and release instructions. |
landing.html | The public Neo home page. |
Start with the question you have
| If you want to understand… | Start here |
|---|---|
| A WhatsApp conversation | src/whatsapp.ts |
| A page on the website | src/web.ts |
| Products and stock | src/catalog.ts |
| Carts and orders | src/orders.ts |
| Payments | src/payments.ts |
| Delivery and tracking | src/shipments.ts |
| How the app starts | src/dev-server.ts |
You do not need to understand every file before making a small change. Begin with the user action, follow the files it calls, and read the matching test.
How one action moves through the code
flowchart LR Person[Buyer or seller] --> Entry[WhatsApp or a web page] Entry --> Rules[Neo checks the request] Rules --> Records[(Neo saves or reads current records)] Records --> Reply[Neo shows the result]
If the diagram does not render, its Mermaid source remains readable above.
For example, a buyer taps Pay Now. The WhatsApp code receives the tap. The order code checks that the order details are still current. The database saves the result. Neo then tells the buyer what happened.
Code that talks to an outside company, such as Meta or a payment company, is kept behind a separate connection so it can be checked or switched off safely.
A simple way to investigate a feature
- Start with what the person does, such as tapping a button or opening a page.
- Find the file that receives that action.
- Follow the next function until you reach the code that owns the rule.
- Read the test that describes the expected result.
- Before saying a feature is live, check whether it is switched on and approved for production.
src/whatsapp.ts and src/web.ts are large because many journeys enter there. The final rules for products, orders, payments, and delivery live in their smaller files.