zula

module
v0.0.0-...-f45d926 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 26, 2021 License: GPL-2.0

README

Zula, The Reading Tribe

Zula is on a mission to amplify diversity and inclusion in children's libraries and bookshelves around the globe!

We are aiming to develop an open-source + premium subscription online library for inclusive childrens books.

Project Setup

  • Backend written in Golang
  • Frontedn written in JavaScript using React
Folder Structure
cmd/
    api/ -- contains API Server start command
pkg/
    api/ -- contains API Server code
        static/ -- contains React frontend
        test/ -- contains Go tests

Running the project locally

The recommended way to run the program locally is to use docker.

$ docker build -t zula . && docker run -d -p 1323:1323 zula

You can then visit the homepage at localhost:1323 or use the API at localhost:1323/api/v1

Directories

Path Synopsis
cmd
api command
pkg
api
src
api module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL