An open API service indexing awesome lists of open source software.

https://github.com/elementary/builds

Frontend to elementary OS Builds
https://github.com/elementary/builds

hacktoberfest vue

Last synced: 8 months ago
JSON representation

Frontend to elementary OS Builds

Awesome Lists containing this project

README

          




elementary




Builds Frontend


Frontend to elementary OS Builds






---

This repository contains the website code for our Early Access builds. This
**DOES NOT** build elementary OS or have any operating system related code.

---

### Building & Testing

This site is built with Nuxt.JS, a Vue.JS framework.

You'll need the following dependencies:

- nodejs >= 20
- npm

Run `npm` to install additional packages and start the development server

```sh
npm ci # Installs additional dependency packages
npm start # Starts the web server
```

A link to the test server will appear in Terminal. (Typically this is `http://localhost:3000/`)

### Testing GitHub & DigitalOcean Spaces integration

To test the GitHub login integration locally, generate a GitHub OAuth application client ID and secret at https://github.com/settings/applications/new
and store them in a `.env` file. Also add a `SIGNING_KEY` which can just be random hex characters used to sign JWT tokens.

```
GITHUB_CLIENT_ID=XXXXXXXXX
GITHUB_CLIENT_SECRET=XXXXXXXXXXXXXXXXXXX
SIGNING_KEY=XXXXXXXXXXXXXXXXXXXXXXX
```

If also testing DigitalOcean Spaces integration, add the secrets:

```
SPACES_KEY=XXXXXXXXXXXXX
SPACES_SECRET=XXXXXXXXXXXXXXXXXXXXXXXXX
```

You can then run the application in production mode with:

```
npx nuxt build
npx nuxt start
```