Giter Site home page Giter Site logo

rsensenig / contra-search Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 907 KB

Contra Search is a one-stop-shop to learn about contra dance and find events near you.

Home Page: https://contrasearch.cyclic.app/

CSS 14.47% JavaScript 32.13% EJS 53.38% Procfile 0.02%
express javascript nodejs

contra-search's Introduction

Table of Contents
  1. About The Project
  2. Getting Started
  3. Scope of Functionalities
  4. Project Status
  5. License
  6. Contact
  7. Acknowledgments

About The Project

[Contra Search

Welcome to Contra Search, a full stack web application. The purpose of this application is to provide a resource to easily connect New England residents to contra dance, a fast-paced folk dance that has its roots in English and French country dancing. I’ve been contra dancing for about 15 years, and have noticed that current contra dance sites are dated both in style and the technologies that they use. As a result, it’s difficult to find information unless you know where to look or have an existing connection to the folk community. I wanted to create a site that would both show the energy and joy behind the dance while also making it easy to find contra dance events near you in New England.

With this application, you can enter a zipcode and be shown the closest contra dances to that location within the New England region.

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow the following steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm install npm@latest -g

Installation

  1. Clone the repo
    git clone https://github.com/CodeSquad-Boston/course-project-rsensenig.git
  2. Install NPM packages
    npm install
  3. Run mongodb using docker (assumes you have docker installed already)
    • docker pull mongo
    • docker run --name mongodb -d -p 27017:27017 mongo
  4. Create a .env file in the root of this project with these values
    SECRET_KEY="a very secret key" # This is fine for testing
    DB_URL="mongodb://localhost:27017" # This matches the docker port above
  5. Run the server
    node app.js
    
    

(back to top)

Scope of Functionalities

Features:

  • search for contra dances in a particular location via zip code
  • submit a contra dance event for the site admin to review and approve
  • an About page tells users what contra dancing is and includes an embedded video to show what the dance looks like
  • send a message to the site admin on the Contact page

To Do:

  • use module for recurring events to create future events based on event series platform
  • add drop down menu to search bar so that you can change the mile radius of your search
  • accept an image as part of the "Submit and Event" form
  • add time filter for events
  • add an "add to calendar" feature so that you can add a contra dance event to your Google, Apple, or Outlook calendar
  • enable looking up a location on Google maps

Project Status

This project is still under development. Here is a log of current bugs that I'm working on:

10/23/2022 - I noticed that regardless of what zip code I enter, the error message "I didn't understand that zip code. Please enter a different one." appears. - RESOLVED

11/7/2022 - currently working on implementing rrule for adding events based on a recurring event series

License

The ISC License

Copyright (c) 2022 Rachel Sensenig

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Contact

Rachel Sensenig - LinkedIn - [email protected]

Project Link: https://github.com/rsensenig/personal-project

(back to top)

Acknowledgments

I would like to thank the 2022 cohort of CodeSquad, including classmates, TFs, and my mentor Bianca Blakesly for their support and guidance.

Here are some resources that were used for this project:

(back to top)

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.