https://github.com/do-community/available-images
A simple list of all images available on DigitalOcean.
https://github.com/do-community/available-images
digitalocean digitalocean-community-tools digitalocean-droplets digitalocean-marketplace hacktoberfest
Last synced: 3 months ago
JSON representation
A simple list of all images available on DigitalOcean.
- Host: GitHub
- URL: https://github.com/do-community/available-images
- Owner: do-community
- License: apache-2.0
- Created: 2020-03-30T19:29:54.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-05T23:05:22.000Z (6 months ago)
- Last Synced: 2025-01-16T17:00:50.762Z (5 months ago)
- Topics: digitalocean, digitalocean-community-tools, digitalocean-droplets, digitalocean-marketplace, hacktoberfest
- Language: Vue
- Homepage: https://do-community.github.io/available-images/
- Size: 3.89 MB
- Stars: 8
- Watchers: 7
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Available Images
A simple list of all images available on DigitalOcean.
---
## Development/Building
To setup the build/develop environment, you will need to run `npm i` with Node 12+ installed. This will install the
dependencies to allow you to build the project.
To build or develop this tool, you will need to create a DigitalOcean API key. To do this, sign into the DigitalOcean
control panel, click "API" in the sidebar and click "Generate New Token" on the screen which appears. Simply create a
read-only token, copy `config.example.js` to a new file called `config.js` and insert your token in this file.
The scripts that use this token also support an environment variable instead of the config file, set the environment
variable `DIGITALOCEAN_TOKEN` to the token and remove the `config.js` file to use this method instead.
To develop for this tool run `npm run dev`.
This will start a development server that will automatically reload the codebase when changes occur.
If you wish to host this tool on a service, simply run `npm run build`. This will run all the necessary build scripts
automatically to build the tool.\
You can then take the `dist` folder and put it on your web server/bucket.
GitHub Actions is setup to do this automatically for this repository to deploy to gh-pages.
## Source Structure
### [`src/available-images`](./src/available-images)
#### [`src/available-images/scss`](./src/available-images/scss)
The scss directory contains the main SCSS styling file for the tool, which imports our do-bulma library and then adds
tool-specific customisations.
#### [`src/available-images/templates`](./src/available-images/templates)
This directory contains the Vue templates that are used to render the tool on the client-side.
`app.vue` is the main Vue file that other templates are referenced into.
### [`src/build`](./src/build)
The build directory contains a special utility script that is used during the initial build of the tool both for
deployments and in development. This script uses the provided DigitalOcean API key and fetches all images,
saving them to local JSON files that the tool then uses.
## Contributing
If you are contributing, please read the [contributing file](CONTRIBUTING.md) before submitting your pull requests.