Skip to content

UbuntuOpenStore/openstore-web-dev

Repository files navigation

OpenStore Web

Meta repo for getting setup with developing the OpenStore.

Reporting Bugs

Please report any bugs/features/requests in our bug tracker.

Translations

If you would like to help out with translations head over to the OpenStore project on the Weblate.

Donations

We rely on donations from generous individuals like you to continue our mission of supporting the Ubuntu Touch community. Your contribution can help us improve the quality of the OpenStore website & app, add new features, and make them more accessible to users around the world. We appreciate any donation, big or small, and thank you for your support in helping us to build a better future for mobile technology! Donate on Liberapay.

Development

  • Initialize submodules:
    • Run: git submodule update --init --recursive
  • Install the docker & docker-compose:
  • Install NPM dependencies:
    • Install api dependencies: cd openstore-api; npm install; cd ..
    • Install web dependencies: cd openstore-web; npm install; cd ..
  • Initialize the translations:
    • Run: cd openstore-web; npm run translations; cd ..
  • Generate the svg icons:
    • Run: cd openstore-web; npm run generate-icons; cd ..
  • Start the docker containers
    • Run: docker-compose up -d
  • Visit the site in your browser: http://local.open-store.io
server {
    listen 80;
    server_name local.open-store.io;
    server_tokens off;
    client_max_body_size 0;

    location / {
        proxy_pass http://localhost:8080;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $http_host;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_buffering off;
    }
}
  • Login
    • Login to the OpenStore to setup your user
    • Upgrade your user to an admin: docker exec -it openstorewebdev_api_1 node /srv/openstore/openstore-api/bin/setup-admin
  • Stop the docker containers (when you are done):
    • Run: docker-compose stop

Configuration

For more info on configuration read the openstore-api/README.md.

License

Copyright (C) 2024 Brian Douglass

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License version 3, as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranties of MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.