/fun-with-yen

A child app built for my daughter and any other users who would like it for their child.

Primary LanguageJavaScriptMIT LicenseMIT

License: MIT Contributors Forks Stargazers Issues LinkedIn

Logo

Fun with Yen

Traceable learning app for my daughter
Explore the docs »

View Demo(Broken) · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

This project was built using Express, Handlebars, mySQL2, sequelize, and materialize.css

Built With

Javascript Node.js Express npm VS Code

Getting Started

Once completely built, this application will function as a deployed app on Heroku

Local Installation / Testing

  1. Clone the rep
git clone https://github.com/404pandas/fun_with_yen.git
  1. Install dependencies
npm run install
  1. Seed the database
npm run seed
  1. Launch the app in development environments
npm run start
  1. Visit:

localhost://

Usage

Once the app is functional, screenshots will be added in this section.

Roadmap

MVP

  • Front End

    • User Auth
    • User Profile Page
      • Routing
      • Styling
    • Landing/Drawing Page
      • Routing
      • Styling

  • Back End

    • Models
    • Seeds
    • apiRouting
    • userRouting
    • traceableItemsRouting

Future Development

  • Add Lines

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

This project is licensed under the MIT license.

See LICENSE.txt for more information.

Contact

Mary Elenius - mary.panda.jackson@gmail.com

Project Links:

Github Repository

Deployment- link later

Acknowledgments

I would like to give a big shoutout to my partner in crime and daughter, Yennefer! She was the inspiration for this app. Every day she proves she is small yet mighty!