An app built to educate teens about menstruation, reduce stigma, and help teenagers keep track of their period.
fork
this repo to your own github account- From your forked repo, click on
<> Code
, then copy the HTTPS URL - In the terminal,
cd
into where you want to save this repo - Run
git clone paste-the-copied-url-here
cd
into the cloned repo- Run
git checkout -b your-own-branch
to checkout (create) a new branch to work on *skip to 'Install' section*
- Before you push your commit, run
git pull
to make sure your local repo is up-to-date with the original remote repo - Do your
git add .
andgit commit -m 'msg'
git push -u origin your-own-branch
to push- Go to your cloned repo and make a pull request
- The
base
should be the original repo,head
is your own local copyyour-own-branch
- Create pull request
- Install Node.js
- In the terminal, run
npm install
- In the terminal, run
npm start
- If you see
Server is running on port 3000
, you have successfully started the server - Open browser, go to
localhost:3000
- You should be able to see content from
views/dashboard.ejs
file - You can now edit any files, then refresh the page in the browser to view changes
- To stop the server from running (in order to use the terminal in VS Code again), press
Ctrl + C
- To add a new EJS file, run
touch views/file-name-you-want.ejs
from the terminal - All EJS files should be in
views
folder - All CSS, JS, and image files should be in their own folder in
public
folder - You can copy everything from
dashboard.ejs
to your newly created EJS file, then replace the content inside<body>
- 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) - To view your new EJS file, go to
routes/index.js
and follow the instruction there