Code Monkey home page Code Monkey logo

choral-admin's Introduction

Choral Admin WebApp

An example repo for an admin panel of a choir website

Admin panel allows for create, read, edit, and delete

  • Choir performances
  • Admins
  • Audition info
  • May add more features in the future

Prerequisites

Node & NPM

To install all project dependences

npm install

To run vue project in development mode

npm run serve

To build the vue project

npm run build

Firebase

This project relies on the following firebase features

  • firestore
  • storage - for storing images
  • cloud functions
  • security rules for firestore and firebase storage

Firebase config

See /firebase/firebaseConfig.js.sample file for an example file.

For information on setting up a firebase project and getting the configuration information visit:

https://firebase.google.com/docs/web/setup

Firebase Cloud Functions

The '/functions' folder contains cloud functions for performing server side operations such as adding and removing user authentication credentials.

Before deploying the cloud functions, you will need to run npm install inside of the '/functions' folder

To deploy cloud functions, run

firebase deploy --only functions

This requires an installation of firebase tools. Please see for a complete example

https://firebase.google.com/docs/functions/get-started

Firebase security rules

To be included later

Built With

  • Vue - The web framework used
  • Vuex - State management for Vue
  • Vue-router - Routing management for Vue
  • NPM - Dependency Management

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

As a stable deployment version emerges we will begin implementing a versioning methodology, potentially following SemVer.

For the versions available, see the tags on this repository.

Authors

  • Jacob Goodwin - Initial work
  • Abel Goodwin - Initial work

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Evan You and everyone building the Vue Framework
  • Those contributing to libraries key to the success of this project
  • Everyone who has and is actively contributing to OSS everywhere

choral-admin's People

Contributors

hampgoodwin avatar jacobsngoodwin avatar

Watchers

 avatar  avatar

choral-admin's Issues

Create login page

Create login page that will load an admin panel if user is authenticated and an admin in database

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.