Git Product home page Git Product logo

brighteventsapi's Introduction

Bright Events API

Bright events provides a platform for event organizers to create and manage different types of events while making them easily accessible to target markets. Event organizers need to register for accounts, so they can create and manage their events. Users (Event Attendees) don't need registration to RSVP to events.

Motivation

Events are created every day, people get to events and others get to miss event RSVP. Motivation to come up with this application has originated from the fact that people need to have access to event details from wherever they are.

Build Status

Build Status Coverage Status Maintainability

Tech/Framework used

The application has been built by:

  • Flask (Python)

Features

This application allows users to:

  • Create accounts and login to the system
  • Create events
  • View, edit (update) and delete events
  • View and RSVP to other events
  • Obtain users who RSVP to their events

Installation

  • Ensure you have
  • python 3.4 installed
  • istalled virtual environment
  • Clone the repo to your local machine
  • Navigate to bright_events folder
  • Create a virtual environment and run the command: pip install -r requirements.txt (install packages)

Start the application

  • The run the following to start the app:
  • python run.py
  • Navigate to postman to test the api endpoints

Tests

To run tests and ensure the application works:

  • Navigate to tests folder on cmd or terminal
  • tests
  • Run the command nosetests with the file name
  • nosetests test_useraccoutnts.py
  • Repeat this with all the files that contain tests i.e.,
  • test_events.py
  • tests_eventdetails.py

Using the application

  • Register to create an account
  • Login using username and password created
  • After signing in you can proceed to create events or RSVP to other events
  • To preview the UI, proceed to https://bright-events-application.herokuapp.com/
  • Access the API documentation at "https://brighteventsapi1.docs.apiary.io/#reference/0/user"

brighteventsapi's People

Contributors

mutoromike avatar

Watchers

James Cloos avatar Karanja Mochu 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.