Skip to content

silicon-slopes-engineer-workshop/coding_pairs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

73 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CODEWITHME

A MERN app used to make a "smart" pairs for pair coding.

CircleCI Coverage Status CII Best Practices Code style PeerDependencies

User Stories - App

  1. Sign up process for each member creating a profile with basic skills levels, pair coding preferences (work with strong/weak etc.)
  2. Upon arrival to a meet up user is to click tasks desried for the day somehow and is matched with another programmer, handle odd group total to pair one group with, this happens only after all present have clicked in so to speak
  3. Phase 2 Stretch Features, Bugs, Enhancements, UI Polishing, comments/notes, login, security for the API, styling pizazz and custom desgin stuff if desired, Some type of history/tracking maybe - like who teh user paired with and what they did etc.

TECH STACK

  • MERN (w/hooks) +Dockerized - deployed with Netlify and Heroku

Repo Rules (pending discussion and/or approval - subject to change - still in progress)

  • You cannot approve your own PR - so two pairs of eyes on ALL PRs.
  • Write clean code, Code to Spec, write tests(TBD), plan each task first (pseudocode) for example:
- DETAILED screen-by-screen design layouts with annotations describing all UI/UX components and all data relevant to the screen, back end story board as well
  • Pair code each Isssue if possible leveling up each task, assigned a pair in class or otherwise on Slack
  • Use a template or process for creating "Issues" whihc got to "TO DO" and are tracked items in the KANBAN board. -- Reference Article: Acceptance criteria
Pattern: Input - process - output
User story - An overview of the intended application and WHY you feel it's valuable to users. Each story is business driven meaning a user benefit
able to illustrate a user story with an example
able to express the acceptance criteria for a user story in terms that will be directly usable as an automated acceptance test
Eliminate unneeded scope - cut out or split up story

Getting Started

Download the repo

git clone https://github.com/silicon-slopes-engineer-workshop/coding_pairs.git

Installation

Skeleton architecture with basic auth

// in client folder with npm
npm install
// in api folder with npm
npm install

Start MongoDB server

// in terminal
mongod;

Create an .env file with a SECRET on the api level

// in api folder with npm
touch.env;

// open file and write
SECRET = yoursecretwordhere;
// then save it

Seed the database with tasks

// cd into api/seeds
node taskSeeds.js

Start dev servers

// in api root folder
npm start

Get Coding

// load in client in the browser on localhost
// in the browser create a new user with the sign up to access all screens including auth protected routes

Contributing to CODEWITHME

CODEWITHME is an MIT-licensed open source project. It's an independent project with ongoing development made possible thanks to the support of the awesome participants of the "silicon-slopes-engineer-workshop" MeetUp.

// use git to create new feature branch with the pattern of task plus a dash with the iteration of that feature
`git checkout -b deploy-framework-1`;

CSS Colors

These are colors for the overall app. Black: #000000 Butter: #FEDC3D Azure: #01ABAA Peach: #FEA680 These are Colors indicating technology categories. Frontend => Orange: #FFA500 Backend => Navy: #000080 Other => Green: #008000

CODE !

Styled Components

(A short tutorial on styled components)[https://youtu.be/JG9DxnopKas] (Styled components on NPM)[https://www.npmjs.com/package/styled-components] (Styled components docs)[https://www.styled-components.com/docs]

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •