ada/powerpanel-webview
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add README.

Browse source
This commit is contained in:
Alexis Werefox 2021-09-15 05:06:53 +00:00
parent 6dd701abce
commit 1455f140ee
1 changed files with 40 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
README.md Normal file
View file

@ -0,0 +1,40 @@
# Source Code for PowerPanel Webview
## Development
You can use the `deploy.sh` script to start up the container in development mode.
```
./deploy.sh dev
```
This will handle starting a new container of Next.js with all required packages for the site in development mode. You should use this if you're planning on running the site using production mode later so you can see changes to your code in real time and test any backend changes.
Keep in mind that you should **never** host this site in development mode publicly. This sentiment reflected in the documentation for Next.js.
## Production
You can also use the `deploy.sh` script to start up the container in production mode.
```
./deploy.sh build
./deploy.sh start
```
The `build` parameter will generate the necessary static assets for the site, including any static pages and JSON. The `start` parameter starts up a production server. If the build fails, you won't be able to start a production server. So, if you decide to issue something like `./deploy.sh build && ./deploy.sh start` just keep that in mind.
## Personalization (Forking)
You're absolutely free to fork this code and make some modifications for your own site! I simply ask that you not host something that looks like it's just my own personal site somewhere else, and that you link either yours or at least the original source code.
### `pages/`
The project itself is split into `pages/`, `data/`, and `components/` mostly. Pages are used to define both the routes and the site pages themselves. They're the most high-level part of the site's structure, since they import data and code from `data/` and `components/` respectively.
### `components/`
Unless you are making *major* changes to a page, you likely will want to edit the code in components. This is where you can edit a lot of the JSX that's defining the different elements of each page. Think of it as editing sections of a template.
### CSS
It's also likely that if you're editing data and components, you'll want to change the theming and styles of things. This project uses [XP.css](https://botoxparty.github.io/XP.css/).