caddy-ui/README.md
2023-11-18 09:18:10 -05:00

36 lines
1,006 B
Markdown

# Caddy Reverse Proxy Web UI
This project provides a user-friendly web interface for managing a Caddy reverse proxy server. With this UI, you can easily view, add, edit, and delete routes, as well as manage user accounts. At least, thats the plan
## Technologies Used
This project is built using the following technologies:
- React
- Next.js
- Tailwind CSS
- Caddy API
## Checklist
- [ ] Dockerfile
- [X] View all Routes
- [X] Delete routes
- [ ] Add routes
- [X] Edit routes
- [ ] User accounts
## Getting Started
To build and run the project, follow these steps:
1. Clone the repository
2. Create a .env file
3. Fill out required information in the .env from the .env.example
4. Install dependencies with `npm install`
5. Start the development server with `npm run dev`
6. Open [http://localhost:3000](http://localhost:3000) in your browser
## Contributions
Contributions are welcome! Feel free to submit pull requests or open issues if you find any bugs or have suggestions for new features.