NOTE: We are currently building out base modules for this and this project is on hold until we have more of a foundation in place. We do not feel this will take too long. To see the MVC we are building to power this, please view our veggiedog project.
firedog intends to be an API generation and management tool similar to Parse and Firebase. Size and scale are open to discussion at the moment so now's the time to chime up. :-)
Ideas
- Move from Express to restify.
- Move from Express to straight Node.
- Make each endpoint act as a microservice that can be individually scaled as needed.
- Move to straight ES6+ instead of TypeScript.
- Dashboard for management.
- Starter templates (CMS, ecommerce, Uber-like, etc).
- Ability to extend via plugins/adapters.
- Sockets.
- Docker & Kubernetes support.
- Multi language SDK's.
- Third-party integrations.
Dependencies
Once the dependencies are installed, open the project in a terminal and enter npm install.
From your terminal, enter npm run start-docker.
Go to http://localhost:3000 in your browser of choice.
Enter the following command in your terminal: docker exec -it mongo mongo.
The project is really a foundation right now and will change over time.
Routes are registered by adding to an existing ./routes/*.router.ts file in the corresponding register() method. If you need a new base route create a new file in the ./src/routes directory ending in .router.ts and use an existing router as an example for how to implement it. Router files are auto loaded on application start.
Sample Routes
- http://localhost:3000 - Returns static payload showing the app is running.
- http://localhost:3000/endpoints - Returns a static list of endpoints (sorted by name).
- http://localhost:3000/users - Returns a static list of users.
- http://localhost:3000/users/contains/:name - Returns boolean if name exists in static array.