Giter VIP home page Giter VIP logo

magmishibai's Introduction

magmishibai

digital kamishibai board by mkr

This application is currently being built. It's my first ever GitHub project. magmishibai consists of nuxt.js and bootstrap-vue so far. It uses vuex for state management and a tiny API that comes in the backend folder as an extra node project.

backend uses MongoDB Atlas per default. Just make sure to enter your configuration data in backend\config.js. You can use backend\config.js.example as a template. If no collection is available in MongoDB, a tiny set of standard data will be created in a collection called "tasks".

I am looking for better ways to set this up. Help/contribution appreciated :)

magmishibai-screenshot

Setup

Frontend

In the project's root folder:

# install dependencies
$ npm install

# serve with hot reload at localhost:3000
$ npm run dev

Backend

No specific setup is required for the frontend. Make sure to enter your configuration data in backend\config.js. A secret for registration/login tokens is required,

In backend folder:

# install dependencies
$ npm install

# start backend API
$ npm run dev

Configuration & additional information

You will need to enter a secret for token based authentication in backend\config.js as well as configuration data for connecting to MongoDB Atlas. Please make sure your file is saved with restrictive access rights. An example configuration file is stored in backend\config.js.example.

A new user needs to be registered at the previously mentioned MongoDB backend before login and access to the kamishibai board is possible.

magmishibai's People

Contributors

mkriesten avatar bennet92 avatar dependabot[bot] avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.