Updates to README

This commit is contained in:
Brian McGonagill 2024-08-14 16:07:55 -05:00
parent 88fa7c1d22
commit 7dc091e6b9

View file

@ -51,6 +51,15 @@ services:
6. move back to the bundle folder, and run `node main.js`. This will start the application running. 6. move back to the bundle folder, and run `node main.js`. This will start the application running.
7. There are multiple node applications to help keep a node js app running in the background, like PM2, etc...but I'll leave that up to you to get going. 7. There are multiple node applications to help keep a node js app running in the background, like PM2, etc...but I'll leave that up to you to get going.
## Documentation
The documentation for Get My is a work in progress. Please bare with me until I am able to get it done. I'll work on it as I have time.
You can find the [documentation here](https://getmydocs.opensourceisawesome.com).
The documentation is being done in the amazing open source software [Bookstack](https://www.bookstackapp.com/).
If you'd like to contribute by writing some documentation, please contact me me with an, and I'll see about getting you access to contribute.
## Keeping it Simple ## Keeping it Simple
- Registration / Login System built in - Registration / Login System built in
- 1st user to register is the system admin by default. - 1st user to register is the system admin by default.
@ -95,10 +104,10 @@ services:
- A full ERP / CRM for your home. - A full ERP / CRM for your home.
- A portal or interface to any shopping / eCommerce sit online. - A portal or interface to any shopping / eCommerce sit online.
## Built With ## Built With
- MeteorJS - [MeteorJS](https://www.meteor.com/)
- Blaze UI - Blaze UI
- MongoDB - [MongoDB](https://www.mongodb.com/)
- Materialize-css - [Materialize-css](https://materializeweb.com/)
## License ## License
MIT MIT