Skip to content

Latest commit

 

History

History
95 lines (67 loc) · 2.82 KB

README.md

File metadata and controls

95 lines (67 loc) · 2.82 KB
Raw

Bolagsverket (Proof of Business) - MyCompany Wallet Portal Backend

About • Release Status • Licensing

About

This repository hosts the source code for Bolagsverket Proof-Of-Business project (Portal backend)

Release Status

Release 1.0 - The release is in alpha demo stage.

Installation

Requirements:

  • python 3.8.1.2

Steps to run

Pre-requisite:

  1. Docker is installed in the local system
  2. Setup up SSH in github

Steps:

  1. Clone this repo
$ git clone https://github.com/L3-iGrant/pob-backend
  1. Change the current direcotry to pob-backend
cd pob-backend
  1. To get an overview of different commands available in the current project run
make

The following commands are currently supported

------------------------------------------------------------------------
Bolagsverket (Proof Of Business) - Backend
------------------------------------------------------------------------
bootstrap                      Boostraps development environment
build/docker/deployable        Builds deployable docker image for preview, staging and production
build/docker/deployable_x86    Builds deployable docker image explicitly for x86 architecture
build                          Builds the docker image
deploy/production              Deploy to K8s cluster (e.g. make deploy/{preview,staging,production})
deploy/staging                 Deploy to K8s cluster (e.g. make deploy/{preview,staging,staging})
publish                        Publish latest production Docker image to docker hub
run                            Run backend locally for development purposes
setup                          Sets up development environment
  1. Build the project
make build
  1. Finally to run the server (http://localhost:8000) locally,
make run

Django admin dashboard is accessible at http://localhost:8000/admin/ endpoint. Super user credentials are as given below:

email: [email protected]
password: admin

Licensing

Copyright (c) 2022-25 Bolagsverket, Sweden

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the LICENSE for the specific language governing permissions and limitations under the License.