nginxconfig.io/README.md

2.6 KiB

⚙️ NGINX configuration generator on steroids 💉

The only tool you'll ever need to configure your NGINX server.
This is the fork of very useful open-source project by Digital Ocean, here's more information about this project:
github.com/digitalocean/nginxconfig.io »


About this fork

This fork is used to implement Digital Ocean's NGINX configurator to REG.RU web-site with some cosmetic tune-ups:

  • unneccessary Digital Ocean stuff removed
  • some styles updated to match REG.RU style-guide
  • some layout improvements implemented
  • static build added to Github repo for deployment

No any logic updates made here, it works just like ofirinal project.

🚀 Usage

GOTO reg.ru/web-tools/nginx-config-generator

▶️ Development

  1. Clone the repository

    git clone https://github.com/regru/nginxconfig.io.git
    
  2. Install NPM packages

    npm ci
    
  3. Run the development server (with file watchers)

    npm run dev
    
  4. Open the development site localhost:8080

  5. Lint your code (eslint & sass-lint)

    npm test
    
  6. Analyze production bundle size & composition

    npm run analyze
    
  7. Build for production (to the dist directory)

    npm run build:regru-static
    

🤝 Contributing

  1. Clone the project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

👨‍💻 Author

Rewrite & maintenance of this fork

Valery Kovalev <v.kovalev@reg.ru> (https://reg.ru)

Rewrite & maintenance of Digital Ocean project

Matt (IPv4) Cowley <me@mattcowley.co.uk> (https://mattcowley.co.uk)

Original version

Bálint Szekeres <balint@szekeres.me> (https://balint.szekeres.me)

📝 License

Copyright © 2021 Reg.ru, Inc (https://www.reg.ru).
Copyright © 2021 DigitalOcean, Inc <contact@digitalocean.com> (https://www.digitalocean.com).
This project is licensed under the MIT license.