leopardslab/3mon

raven

3rd party service monitoring tool

Install

npm install -g raven-monit

Getting Started

# clone it
git clone [email protected]:leopardslab/raven.git
cd raven

# Install dependencies
npm install

# Start development live-reload server
MONGO_CONNECTION_URL=mongodb://<user>:<password>@<hostname>:<port>/<dbname> PORT=8080 npm run dev

# Start production server:
MONGO_CONNECTION_URL=mongodb://<user>:<password>@<hostname>:<port>/<dbname> PORT=8080 npm start

Docker Support

cd express-es6-rest-api

# Build your docker
docker build -t leopardslab/3Mon .
#            ^      ^         ^
#          tag  tag name      Dockerfile location

# run your docker
docker run -p 8080:8080 leopardslab/3Mon
#                 ^            ^
#          bind the port    container tag
#          to your host
#          machine port

# run mongo
docker run -p 27017:27017 --name raven-mongo mongo

Misc

• OpenMetrics - Open standard for metrics

License

MIT © leopardslab

3mon's Issues

[config] Common configuration file for both servers

In present, we had to traverse within both client and server directories to start the respective servers. So, a common configuration file for handling actions of both the servers.

I would like to take up this issue 👍

There is no dockerfile configuration added to the readme file

#Edit the readmefile with these configuration
#for live server
CMD MONGO_CONNECTION_URL=mongodb://:@:/ PORT=8080 npm run dev
#for production server
CMD MONGO_CONNECTION_URL=mongodb://:@:/ PORT=8080 npm start
#There is no configuration added for mongodb inside dockerfile . So it should run manualy.

[config] Config file is not included in .gitignore

config.json file must be included in .gitignore because once we added the personal configuration in the file, before committing the changes we have to clear it first.

Proposed Solution:

Instead of pushing config.json, we can add a config.example.json file. So, it will prevent the developer to commit their own configurations.

node modules haven't been added to the Git ignore file

Current Behavior

• While I was setting up the project I found that the node modules haven't been ignored

Expected Behavior

• node modules can be removed when committing to GitHub

installing command not working

installing command not working inside the repo
**Not Found - GET https://registry.npmjs.org/raven-monit **
May be not published on the npm registry.

[bug] On running dev server without MONGO_CONNECTION_URL

On running npm run dev command without MONGO_CONNECTION_URL, the server crashes as a config.json file is not imported.

I am working on this issue.

[refactor] Refactoring the react app structure

Refactoring the react app structure referencing to the very popular react-boilerplate and use webpack instead of react-scripts.

I would like to take up this work.