Add readme and license

This commit is contained in:
Daniel Vassallo
2019-10-01 09:30:22 -07:00
parent 567d5dc500
commit 3c4ee075d1
2 changed files with 72 additions and 0 deletions

51
README.md Normal file
View File

@@ -0,0 +1,51 @@
# Userbase Homepage
This is what generates the https://userbase.dev website.
If you want to develop websites like it was 1997, feel free to reuse this for your website.
### Structure
* [/src/template.html](src/template.html) contains the common HTML wrapping around every page.
* [/src/pages](src/pages) contains the HTML body for each page of the website.
* [/src/partials](src/partials) contains common HTML fragments shared by multiple pages.
* [/src/style.css](src/style.css) holds all the CSS, using [Tailwind CSS](https://tailwindcss.com).
* [/src/index.js](src/index.js) holds all the JS, which can be written in ES6.
### Development
```
# clone this repo
git clone https://github.com/encrypted-dev/homepage.git
# go to the repo directory
cd homepage
# install all dependencies
npm install
# start the website on http://localhost:3000 with hot module reloading
npm start
```
### Production
```
# install all dependencies using the versions in package-lock.json
npm ci
# generate the build artifacts in the dist directory
npm run build
```
### Deployment
You can 1-click deploy to the internet using [Netlify](https://www.netlify.com):
<!-- Markdown snippet -->
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/encrypted-dev/homepage)
## License
This project is released under the [MIT License](LICENSE).