Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaybhutani/statuspage
https://github.com/kaybhutani/statuspage
Last synced: about 15 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/kaybhutani/statuspage
- Owner: kaybhutani
- License: mit
- Created: 2024-10-14T07:36:33.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-10-18T09:14:16.000Z (3 months ago)
- Last Synced: 2024-11-26T08:17:47.195Z (2 months ago)
- Language: TypeScript
- Homepage: https://plivo-statuspage.vercel.app
- Size: 305 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Statuspage App
This is a service management application built with Next.js, React, and MongoDB. It allows users to manage services, track their status, and view event logs.
## Features
- User authentication with Auth0
- Service creation, updating, and deletion
- Service status management
- Event logging for services
- Dashboard with service statistics and recent events
- User management
## Prerequisites
- Node.js (v18 or later)
- MongoDB
- Auth0 account
## Getting Started
1. Clone the repository:
```
git clone https://github.com/kaybhutani/statuspage
cd statuspage
```
2. Install dependencies:
```
npm install
```
3. Set up environment variables:
- Copy the `.env.template` file to `.env`:
```
cp .env.template .env
```
- Open the `.env` file and fill in the required values:
- Auth0 credentials (CLIENT_ID, CLIENT_SECRET, DOMAIN, etc.)
- MongoDB connection string
- Other configuration variables
4. Run the development server:
```
npm run dev
```
5. Open [http://localhost:3000](http://localhost:3000) in your browser to see the application.
## Deployment
To deploy the application to a production environment:
1. Build the application:
```
npm run build
```
2. Start the production server:
```
npm start
```
Make sure to set the appropriate environment variables in your production environment.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MIT License.