Freenet Org Website Development Notes
Overview
This is the repository for the Freenet project website. It is built on the Kweb framework in Kotlin, and is hosted on Google Cloud. There is a staging site at https://staging.freenet.org/, and the live site is at https://freenet.org/. Pushes to the staging branch will be automatically deployed to staging, while pushes to the production branch will go live.
Prerequisites
- A Recent Java Development Environment
- Gradle Build Tool
- IntelliJ IDEA (optional but highly recommended)
Setting up
- Clone the repository, two options:
- Command Line
$ git clone [email protected]:freenet/freenetorg-website.git
- IntelliJ IDEA
- File -> New -> Project from Version Control -> Git
- Enter the URL of the repository,
[email protected]:freenet/freenetorg-website.git
- Command Line
- Open the project in IntelliJ IDEA
- Create a new run configuration
- Run -> Edit Configurations...
- Click the
+
button and selectApplication
- Name the configuration
freenet.org website
- Set the
Main class
toorg.freenet.website.MainKt
- Set environment variables to
FREENET_SITE_LOCAL_TESTING=true
- This will use dummy data so no connection to the database is required
- Run the configuration
- Open a browser and navigate to http://localhost:8080/
Pull Requests
To submit improvements create a pull request against the staging
branch.