Browse Source

Updated readme and partners.yml

main
Alexis Werefox 3 months ago
parent
commit
165cc8fdc0
  1. 48
      README.md
  2. 4
      src/info/data/identities/partners.yml
  3. BIN
      src/info/public/images/elizafox.png
  4. BIN
      src/info/public/images/karma.png

48
README.md

@ -1,22 +1,52 @@
# Source Code for [info.werefox.dev](https://info.werefox.dev)
Here's all the source code for the site I generate at [info.werefox.dev](https://info.werefox.dev).
Here's all the source code for the site I host on [info.werefox.dev](https://info.werefox.dev).
(If the subdomain changes, I'll update the README)
## Usage
## Development
I don't really have any instructions for ya yet, but if you wanna get this up and running yourself, here are some usage steps.
You can use `start.sh` to start up the container in Dev mode.
You can use the `start.sh` script to start up the container in development mode.
```
./start.sh dev
```
Or, if you want to build for Production:
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 `start.sh` script to start up the container in production mode.
```
./start.sh build
./start.sh start
```
./start build
./start 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 `./start.sh build && ./start.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. Additionally, if you intend to keep [Mutant Standard emoji](https://mutant.tech/), please do not forget to include the Creative Commons license statement.
### `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.
### `data/`
If you're mainly interested in editing the various text and such from the site, you're gonna be looking at the files in the `data/` subdirectory. It's very likely you'll also want to make some changes to the components at some point if you're doing this, but if you just wanna mess around so you can get a better understanding of how things work together, this is a great place to start.
### `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 [tailwindcss](https://tailwindcss.com/), which is quite unique amongst most CSS frameworks.
Without writing an intro to the framework itself, I'll give a brief summary. If you take a look into the components, you'll notice that tags tend to have a *lot* of class names. Tailwindcss uses these class names to apply specific styling to elements, rather than making sets of CSS files to define styling based on classes and ids.
If you want to change the color palletes of things, you should look at `tailwind.config.js`. This file can define quite a few other things throughout the CSS framework, but I'll leave the investigation of that to some reading through of their documentation.

4
src/info/data/identities/partners.yml

@ -1,7 +1,7 @@
--- # Partners YAML
Gumby:
url: "https://puppy.cafe/@Gumby"
Dax:
url: "https://masto.werefox.dev/@Dax"
avi: "/images/gumby.jpeg"
fields:
Pronouns: "She/They/It"

BIN
src/info/public/images/elizafox.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 110 KiB

BIN
src/info/public/images/karma.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 184 KiB