mirrors/oneuptime
1
0
Fork 0
mirror of https://github.com/OneUptime/oneuptime synced 2024-11-21 22:59:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Nawaz Dhandala 2019-11-27 22:10:15 +00:00
parent 211c7c7ab4
commit 5abe9cdb48
1 changed files with 35 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -1,2 +1,36 @@
# Fyipe Project
# Fyipe
## Description of the projects in this repo.
- `accounts` - A React project used for Authentication (Log in, Sign up, Forgot Password, etc.)
- `dashboard` - A React project for Fyipe user where user can interact with the Fyipe platform.
- `admin-dashobard` - React Project where admin can block users, delete projects and more.
- `api-docs` - HTML/CSS project. A public reference of Fyipe documentation.
- `backend` - NodeJS Service. It's Fyipe API's.
- `home` - HTML/CSS. Home Page / Marketing page of Fyipe.
- `kubernetes` - yaml files to deploy fyipe on staging, production or any enterprise kubernetes cluster. This also contains DevOps/CI/CD scripts.
- `marketing` - This is where you'll find logos, brief description of Fyipe, etc.
- `certifications` - SOC/ISO/PCI certifications and more.
- `postman-collection` - Postman collection for Fyipe API.
- `probe` - Probe is an agent that gets insalled on a third party server on a thir party datacenter and it monitors users websites, services, from that data center. You can deploy multiple probes to monitor users resources - A probe in a datacenter in EU, in US, etc.
- `server-monitor` - A probe that gets installed on a server and that monitors that particular server.
- `smoke-test` - Smoke test that is executed after Fyipe is deployed to staging or production. If smoke test fails, the staging / production deployment will automatically be rolled back.
- `status-page` - React project - Status page project of Fyipe.
- `zapier` - Fyipe integrates with zapier. This is where integration code is. This gets deployed to zapier directly.
## Running this project in local environment.
To run the project in local development. Please follow this steps:
- `./install.sh` - Installs npm dependencies in all the projects.
-
## Running the project in staging.
## Running the project in production.
## LISENCE
Copyright (C) HackerBay, Inc - All Rights Reserved
Unauthorized copying of this project, via any medium is strictly prohibited
This project is proprietary and confidential