Skip to content

An app built to educate teens about menstruation, reduce stigma, and help teenagers keep track of their period.

Notifications You must be signed in to change notification settings

nideheyi/period-app-for-teens

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

period-app-for-teens

An app built to educate teens about menstruation, reduce stigma, and help teenagers keep track of their period.



Instructions

Clone this repo to your local machine

  1. fork this repo to your own github account
  2. From your forked repo, click on <> Code, then copy the HTTPS URL
  3. In the terminal, cd into where you want to save this repo
  4. Run git clone paste-the-copied-url-here
  5. cd into the cloned repo
  6. Run git checkout -b your-own-branch to checkout (create) a new branch to work on
  7. *skip to 'Install' section*
  8. Before you push your commit, run git pull to make sure your local repo is up-to-date with the original remote repo
  9. Do your git add . and git commit -m 'msg'
  10. git push -u origin your-own-branch to push
  11. Go to your cloned repo and make a pull request
  12. The base should be the original repo, head is your own local copy your-own-branch
  13. Create pull request

Install

  1. Install Node.js
  2. In the terminal, run npm install

Start server

  1. In the terminal, run npm start
  2. If you see Server is running on port 3000, you have successfully started the server
  3. Open browser, go to localhost:3000
  4. You should be able to see content from views/dashboard.ejs file
  5. You can now edit any files, then refresh the page in the browser to view changes
  6. To stop the server from running (in order to use the terminal in VS Code again), press Ctrl + C

Add/edit files

  1. To add a new EJS file, run touch views/file-name-you-want.ejs from the terminal
  2. All EJS files should be in views folder
  3. All CSS, JS, and image files should be in their own folder in public folder
  4. You can copy everything from dashboard.ejs to your newly created EJS file, then replace the content inside <body>
  5. To link to your own JS file from an EJS file, add <%- include('/js/your-js-file.js') %> to the bottom of the EJS file (where you would add your <script> tag)
  6. To view your new EJS file, go to routes/index.js and follow the instruction there

About

An app built to educate teens about menstruation, reduce stigma, and help teenagers keep track of their period.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 43.8%
  • EJS 38.1%
  • CSS 18.1%