https://github.com/freenet/freenetorg-website
The code behind https://freenet.org/ and https://staging.freenet.org/
https://github.com/freenet/freenetorg-website
freenet google-cloud-platform kotlin kubernetes kweb
Last synced: about 1 year ago
JSON representation
The code behind https://freenet.org/ and https://staging.freenet.org/
- Host: GitHub
- URL: https://github.com/freenet/freenetorg-website
- Owner: freenet
- License: agpl-3.0
- Created: 2022-09-06T16:27:24.000Z (almost 4 years ago)
- Default Branch: staging
- Last Pushed: 2024-06-25T04:56:11.000Z (almost 2 years ago)
- Last Synced: 2024-06-25T05:54:10.915Z (almost 2 years ago)
- Topics: freenet, google-cloud-platform, kotlin, kubernetes, kweb
- Language: JavaScript
- Homepage:
- Size: 4.89 MB
- Stars: 8
- Watchers: 8
- Forks: 3
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Freenet Org Website Development Notes
## Intro
This is the repository for the Freenet project website. It is built on the [Kweb](https://github.com/kwebio/kweb-core)
framework in Kotlin, and is hosted on [Google Cloud](https://cloud.google.com/). There is a staging site at
https://staging.freenet.org/, and the live site is at https://freenet.org/. Pushes to the
[staging branch](https://github.com/freenet/freenetorg-website/tree/staging) will be automatically deployed to staging,
while pushes to the [production branch](https://github.com/freenet/freenetorg-website/tree/production) will go live.
## Source
* [main.kt](https://github.com/freenet/freenetorg-website/blob/staging/src/main/kotlin/org/freenet/website/main.kt) - Main entry point
* [LandingPageComponent](https://github.com/freenet/freenetorg-website/blob/staging/src/main/kotlin/org/freenet/website/landing/LandingPageComponent.kt) - Landing page
## Prerequisites
1. [A Recent Java Development Environment](https://adoptopenjdk.net/)
2. [Gradle Build Tool](https://gradle.org/install/)
3. [IntelliJ IDEA](https://www.jetbrains.com/idea/download/) (optional but highly recommended)
## Setting up
1. Clone the repository, two options:
1. Command Line
```bash
$ git clone git@github.com:freenet/freenetorg-website.git
```
2. IntelliJ IDEA
1. File -> New -> Project from Version Control -> Git
2. Enter the URL of the repository, `git@github.com:freenet/freenetorg-website.git`
2. Open the project in IntelliJ IDEA
3. Create a new run configuration
1. Run -> Edit Configurations...
2. Click the `+` button and select `Application`
3. Name the configuration `freenet.org website`
4. Set the `Main class` to `org.freenet.website.MainKt`
7. Set environment variables to `FREENET_SITE_LOCAL_TESTING=true`
* This will use dummy data so no connection to the database is required
4. Run the configuration
5. Open a browser and navigate to http://localhost:8080/
## Pull Requests
To submit improvements create a pull request against the `staging` branch.