Skip to content

JPR95/bc13_final-project_front-end-room_10_the_recruitables

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


List of Contents

  1. Introduction
  2. Demo
  3. Features
  4. Getting Started
  5. Tech Stack
  6. Color Reference
  7. The Team
  8. Appendix



Cosmic Calcs 🚀

Welcome to Cosmic Calcs!

A learning resource for teachers, parents and- most importantly- kids!

We know homework can be dull. Cosmic Calcs turns teduious maths worksheets into short, vibrant games which hone mental maths skills for pupils aged 5 to 9. Play for points to progress to new challenges and unlock customisable features for your alien avatar.



Demo-Video

Features 📱

  • Personalised profile based on your child's age and ability.
  • Games progress in difficulty as your child practices and earns points.
  • Progress leaderboard visible only to teachers.
  • Maths activities spanning the whole national cirriculum for KS1 and KS2 (year groups 1, 2, 3 and 4).
  • Customisable avatar; keeping children engaged and incentivised.
  • Sound effects and animation.


Getting Started

Backend

The backend is deployed on Render. However, if you would like to run locally you will need to follow the steps below.

Git clone the backend repository by pasting the following into your terminal:

  git clone https://github.com/SchoolOfCode/bc13_final-project_back-end-room_10_the_recruitables

Install all required dependencies by running:

  npm i

Copy your database (e.g. ElephantSQL) URL into the .env file, following the format:

  DATABASE_URL = <Database URL goes here>

Create all tables in your database by running the following scripts in the terminal:

  npm run db-create-tables

Finally, to run the server locally use the following script within your terminal:

  npm run dev

Front-end

To run the front-end locally follow the steps below:

  1. Git clone the front-end repository by pasting the following into your terminal:
git clone https://github.com/SchoolOfCode/bc13_final-project_front-end-room_10_the_recruitables
  1. Remember to navigate to the correct folder: bc13_final-project_front-end-room_10_the_recruitables/cosmic-calcs

  2. Install all necessary dependencies by running the following command in the terminal:

  npm i
  1. Start the app using:
  npm start

Tech Stack⚙️

Client: React.js, CSS, FireBase

Server: Node.js, Express, PostgreSQL

Client-side Testing: React Testing Library, Cypress, Jest

Server-side Testing: Supertest, Jest



Colour Reference 🎨

Colour Hex
Purple #501785 #448FFF
Green #00621c#00621c
Pink #e79fc4 #e79fc4
Yellow #fce30a #fce30a
Red #e60000 #e60000
Blue #00a3e6 #00a3e6
Orange #ff6600 #ff6600


Our Team 🌍



Appendix 🖊️

About

Week 13 Project - Cosmic Calculations

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 80.2%
  • CSS 19.1%
  • HTML 0.7%