Merge branch 'dev' into 'main'

Update Readme

See merge request bmcgonag/get_my!7
This commit is contained in:
Brian McGonagill 2024-08-14 21:28:48 +00:00
commit 8300aee48e

View file

@ -33,7 +33,7 @@ services:
container_name: get_my-mongo
image: mongo
volumes:
- ./data:/data/db # this will store the application data in the same directory where you have the docker-compose.yml file.
- ./data:/data/db # this will store the application data in the same directory where you have the docker-compose.yml file. the directory on your host will be called 'data'.
restart: unless-stopped
```
@ -51,6 +51,15 @@ services:
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.
## 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
- Registration / Login System built in
- 1st user to register is the system admin by default.
@ -95,10 +104,10 @@ services:
- A full ERP / CRM for your home.
- A portal or interface to any shopping / eCommerce sit online.
## Built With
- MeteorJS
- [MeteorJS](https://www.meteor.com/)
- Blaze UI
- MongoDB
- Materialize-css
- [MongoDB](https://www.mongodb.com/)
- [Materialize-css](https://materializeweb.com/)
## License
MIT