Skip to content

Commit f9d153f

Browse files
committed
docs: add Readme for website
1 parent 9498b68 commit f9d153f

File tree

2 files changed

+81
-0
lines changed

2 files changed

+81
-0
lines changed

CONTRIBUTING.md

+11
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,17 @@ If you'd like to help out with the source code, follow these guidelines:
5050
5. **Commit Your Changes:** Write a clear commit messages explaining the reason and context for your changes, this will facilitate for other collaborators to understand the scope of your contributions.
5151
6. **Create a Pull Request:** Submit a pull request from your branch with a clear explanation of the changes that you've made to the original project repository, along with the links to issues referenced (`Closes #123`, `Fixes #345`) .
5252

53+
## Contributing to the Blankie Website
54+
55+
The Blankie website (https://blankie.rest) currently maintains a perfect 100 score across all Google Lighthouse categories:
56+
57+
* Performance
58+
* Accessibility
59+
* Best Practices
60+
* SEO
61+
62+
Any contributions to the website should attempt maintain these scores. Please test your changes using Lighthouse before submitting a pull request. You can run Lighthouse tests using Chrome DevTools.
63+
5364
## Other Contributions
5465

5566
For now we are not accepting contributions in the following areas, but we hope to in the future:

docs/README.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Blankie Website
2+
3+
This is the website for [Blankie](https://blankie.rest), built with [Astro](https://astro.build) and deployed on GitHub Pages.
4+
5+
## Production
6+
7+
The live site is available at [https://blankie.rest](https://blankie.rest)
8+
9+
## Tech Stack
10+
11+
- [Astro](https://astro.build) - Static Site Generator
12+
- [Tailwind CSS](https://tailwindcss.com) - Styling
13+
- [astro-seo](https://github.com/jonasmerlin/astro-seo) - SEO optimization
14+
- [@playform/compress](https://github.com/playform/compress) - Asset compression
15+
16+
## Performance
17+
18+
The website maintains a perfect 100 score across all categories in Google Lighthouse (Performance, Accessibility, Best Practices, and SEO). All contributions should ensure these scores are maintained.
19+
20+
## Development
21+
22+
You can develop either locally or using Docker Compose. Both methods will give you hot-reloading and the same development experience.
23+
24+
### Using Docker Compose (Recommended)
25+
26+
From the root directory of the project, simply run:
27+
28+
```bash
29+
docker compose up
30+
```
31+
32+
The development server will be available at `http://localhost:4321`. The container will automatically reload when you make changes to the source files.
33+
34+
### Local Development
35+
36+
- Note: Node.js 22 or later is required to run the development server.
37+
38+
If you prefer developing without Docker, open a terminal inside the `docs` directory, then run the following commands:
39+
40+
1. Install dependencies:
41+
42+
```bash
43+
npm install
44+
```
45+
46+
2. Start the development server:
47+
48+
```bash
49+
npm run dev
50+
```
51+
52+
3. Build for production:
53+
54+
```bash
55+
npm run build
56+
```
57+
58+
4. Preview the production build:
59+
60+
```bash
61+
npm run preview
62+
```
63+
64+
## Deployment
65+
66+
The site is automatically deployed to GitHub Pages at [https://blankie.rest](https://blankie.rest) when changes are pushed to the `main` branch that affect files in the `docs` directory or the GitHub Actions workflow file. The deployment is handled by the GitHub Actions workflow defined in `.github/workflows/pages.yml`.
67+
68+
## License
69+
70+
The documentation website is included under the project's MIT License. See the [LICENSE](../LICENSE) file for details.

0 commit comments

Comments
 (0)