Medkids is a resource to enable children interested in the field of medicine to effortlessly comprehend what a career in the field of medicine entails.
Our tech stack for Medkids is WordPress and custom CSS and JavaScript.
Here are stpes to get started contributing to the project
- Step 1: Get onboarded to the Medkids web developemnt slack channel.
- Step 2: Get assigned a design file by Tamara.
- Step 3: Get Invitation to Monday.com from Tamara where you can access the design files.
- We have 2 WordPress sites, one is staging, for trying out ideas before is goes to production. Your approaved staging goes to production.
- Step 4: Send your email for invitation to staging.
- Login to staging : Staging
- Step 5: Accept invitation to staging, LOGIN and starting implimenting Figma designs in Wordpress staging.
- If you are not familar with using WordPress for web design ,get started here Begineers to WordPress Video Resource
-
Only the team lead is allowed to install or uninstall plugins or Themes. Reach out to team lead if you have to add or uninstall a theme or plugin
-
Design your web pages to be responsive for Mobile, Tablet and Desktop.
-
Use Custom
CSS & JS pluginto write custom CSS and JavaScript. -
Create and write your custom
CSS and JavaScriptintask-name.cssandtask-name.jsfiles (task-name is the name of task you are working on and the CSS or JS should be given the project name-Just use your project name as CSS file name ). Every JavaScript file you should be witten within theDOMContentLoadedeventExample.windows.addEventListener('DOMContentLoaded', function(){ /** Add JavaScript here ***/ const textContent = 'Hello world'; })
-
For Custom CSS here is how we class elements to add custom styling or select for JavaScript.
-
We follow Block Element Modifier (BEM) convention to give a class name to elements.Read more on BEM
-
Leave a comment within the CSS and JS to show start of code and to document your code.
-
CSS UNITS: All CSS units should be written in
rem, note1rem = 16px. -
Define
html { font-size:16px; }
on your custom CSS so we can ensure that 1rem = 16px
-
For Mobile Heading and Sub Heading subtract 0.75rems from the Desktop values, base text remains 1rem.
-
For Tablet Heading and Sub Heading subtract 0.5rems from the Desktop values, base text remains 1rem.
-
Assets: All Medkids assets are hosted at MEDKids Image Hosting repository do not host images directly in production or statging WordPress.
-
While linking to assets the link prefix should be
https://rebeccaeverlenetrustco.github.io/images/followed by theassets folderfollowed by theassets namedot the extension. Example:https://rebeccaeverlenetrustco.github.io/images/Nurse_Nurse_Playground/Nurse_Nurse_Playground_Vector.png. -
Export all the images from the Figma task into a folder. Name folder with project name and separate spaces with
-or_or both as the case may be.Next clone the Medkids image respository here , Add your folder with images and make pull request. Leave a message in the team slack for approval. -
Name assets exactly the way they are named in Figma file but with
underscorewhen uploading to image storage. Use task name as aprefixbefore the asset name EG i am working on a task on Big Energy Body, i should name my file like this Big_Ener_Body_vector1vector1being the asset name. -
Approval: Get approval from team leads before publishing to production.
Visit https://github.com/MEDkids/.github to create New Issue regarding your task.
- On the issue page click
New Issue - Add a title
- Add a description : Explain what issue you are creating. Issues can be technical problems or your uncompleted task you want to keep track off or an uncompleted feature on a task
- Click
Submit new issueNote: You are not allowed to close issue.
WP staging is like our development branch and WP product is like our master branch