RouteMeHome/get_my
1
0
Fork 0
mirror of https://gitlab.com/bmcgonag/get_my.git synced 2026-03-27 00:08:49 +00:00
Code Issues 1 Projects Releases Packages Wiki Activity Actions

Merge branch 'dev' into 'main'

Browse source 
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
1 changed files with 14 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -33,7 +33,7 @@ services:
container_name: get_my-mongo container_name: get_my-mongo
image: mongo image: mongo
volumes: 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 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. 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