Updated README.md

This commit is contained in:
brian 2023-11-20 04:48:56 -05:00
parent 71f7543f95
commit 9538b1a9b3

View file

@ -2,6 +2,30 @@
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 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
## Features
* Dockerfile
* View all Routes
* Delete routes
* Add routes
* Edit routes
## TODO
- [ ] Authentication
- [ ] Persistant storage
## 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. Build docker image with `docker build . -t caddy-ui:latest`
5. Start the development server with `docker run --env-file .env -p 3000:3000 caddy-ui`
6. Open [http://localhost:3000](http://localhost:3000) in your browser
## Technologies Used ## Technologies Used
This project is built using the following technologies: This project is built using the following technologies:
@ -11,26 +35,6 @@ This project is built using the following technologies:
- Tailwind CSS - Tailwind CSS
- Caddy API - Caddy API
## Checklist
- [X] Dockerfile
- [X] View all Routes
- [X] Delete routes
- [X] Add routes
- [X] Edit routes
- [ ] Authentication
## 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
Contributions are welcome! Feel free to submit pull requests or open issues if you find any bugs or have suggestions for new features. Contributions are welcome! Feel free to submit pull requests or open issues if you find any bugs or have suggestions for new features.