Skip to content

AudTheCodeWitch/OurCAL

Repository files navigation

Welcome to OurCAL 👋

Version License: MIT Twitter: AudTheCodeWitch

OurCal is a community-generated Crochet-Along (CAL). Anyone can design a block using the graphghan generator and submit it to our database. Users can then view one another's blocks and implement their favorites in a one-of-a-kind blanket!

Usage

OurCAL runs on PostgreSQL. To start your PostgreSQL server, run:

$ sudo service postgresql start

Create the database, run migrations, and seed it:

$ rails db:create
$ rails db:migrate
$ rails db:seed

Start the backend server by running:

$ rails s -p 3001

cd into ./client and start the frontend server by running:

$ yarn start

Author

👤 Audrea Cook

🤝 Contributing

In the future, we would like to add a few features:

  • Add user sessions
  • Add the ability to edit one's submitted patterns
  • Add the ability to view patterns by designer
  • View other's patterns in your color scheme
  • Arrange selected blocks on a blanket template
  • Generate written instructions for patterns
  • Add a print-friendly view of patterns with instructions
  • Redesign layout from a mobile-first perspective

Contributions, issues and feature requests are welcome.
Check out the contributors' Code of Conduct.

Show your support

Give a ⭐️ if you enjoyed OurCAL!

📝 License

Copyright © 2020 Audrea Cook.
This project is MIT licensed.



This README was generated with ❤️ by readme-md-generator