7x31
/
nginxconfig.io
mirror of https://github.com/digitalocean/nginxconfig.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add more development instructions to readme

This commit is contained in:
MattIPv4 2020-06-04 15:34:32 +01:00
parent c312276350
commit 1d8af514b0
1 changed files with 28 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -64,22 +64,40 @@ routing, reverse proxy, www/non-www redirect, CDN, PHP (TCP/socket, WordPress, D
* GitHub: [@0xB4LINT](https://github.com/0xB4LINT) * GitHub: [@0xB4LINT](https://github.com/0xB4LINT)
* LinkedIn: [@0xB4LINT](https://www.linkedin.com/in/0xB4LINT/) * LinkedIn: [@0xB4LINT](https://www.linkedin.com/in/0xB4LINT/)
## ▶️ Install locally ## ▶️ Development
1. Clone the repository 1. Clone the repository
```sh ```sh
git clone https://github.com/digitalocean/nginxconfig.io.git git clone https://github.com/digitalocean/nginxconfig.io.git
``` ```
2. Install NPM packages 2. Install NPM packages
```sh ```sh
npm ci npm ci
``` ```
3. Run the development server *(with file watchers)* 3. Run the development server *(with file watchers)*
```sh ```sh
npm run dev npm run dev
``` ```
4. Open the development site **[localhost:8080](http://localhost:8080)** 4. Open the development site **[localhost:8080](http://localhost:8080)**
5. Lint your code *(eslint & sass-lint)*
```sh
npm test
```
6. Analyze production bundle size & composition
```sh
npm run analyze
```
7. Build for production *(to the `dist` directory)*
```sh
npm run build
```
## 🤝 Contributing ## 🤝 Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Contributions are what make the open source community such an amazing place to be learn, inspire, and create.