Skip to content

A web app that the School of Code bootcampers can use in order to document their mentorship experience.

Notifications You must be signed in to change notification settings

vmilitaru/Mentorship-Diary-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mentorship Diary Application

Our project brief was to build an app that would enhance the School of Code mentoring experience and the solution that the team of 4 people I was part of, managed to come up with in less than a week, was this tool that allows School of Code bootcampers to track and document their mentor/mentee relantionship.This is basically an online diary of the School of Code bootcamper mentorship journey.

The application consist of a Home page:

mentorship-diary-home

Weekly Form where mentee can go through a predefine set of questions together with their mentor.The questions are set with placeholder text to help guide the discussion.

mentorship-diary-weekly-form

The data is unique to user and can be viewed on the Achievement History page by selecting the prefered week to review.

mentorship-diary-achievement-history

We also added in a Contact page with School of Code contacts.

mentorship-diary-contact

The Authentication was done using Firebase .

mentorship-diary-authentication

If you want to see the frontend code of this application head to this repository.

Live Project

Here is the deployed version.

Stack

Getting started

  1. Clone the repo: https://github.com/vmilitaru/Mentorship-Diary-server.git

  2. Download the required npm modules: npm i

Configuring a Database on Heroku

Setting up a database on Heroku :

  1. Go to heroku and sign up for a free account.

  2. Create a new app, give it a name and select the region.

  3. Navigate to the resources tab of your new app.

  4. In the Add-ons search bar, type postgres and select Heroku Postgres.

  5. Select the Hobby Dev - Free plan and click Submit Order Form.

  6. Click the link to Heroku Postgres, this will open a new tab and under the Settings tab you will be able to view your credentials.

Set up environment variables

To connect the server with your Heroku database you'll need to locate your credentials in the settings tab and set the appropriate environment variables.

  1. Copy the content of .env.example into a new file called .env.local at the root of this project, then add the missing environment variables:

    • PGHOST, PGUSER, PGDATABASE, PGPASSWORD and PGPORT - Can be found in the Heroku Dashboard>Your App>Overview>Heroku Postgres>Settings under View Credentials

Available Scripts

In the project directory, you can run:

npm start

Runs the server in the development mode.

npm createTable

This script is creating the table in your new set up Heroku data base.

Deploy on Heroku

You can deploy this server to the cloud with Heroku (Documentation).

Deploy Your Local Project

One way of deploying your local project to Heroku is with GitHub.

  • Push your code to GitHub and make sure you granted access to your Heroku account as well to your Github account.You can check that in Account Settings under Applications tab in Third-party Services section.

  • Then navigate back to your project and under the Deploy tab select as the Deployment method: Github.

  • Select the GitHub account where your repository is and search the repo you want to connect with, then click Connect.

  • Make sure to enable the Automatic deploys section if you want to re-deploy your code for every change you push up to GitHub.

  • Select the relevant branch you want to deploy and click Deploy Branch.

  • In the Activity tab you can check the deployment progress and when the app goes live.

Important: We still need to connect the server with the database and the way to do that is to specify our Environment Variables in the deployed application.

  • Go to Settings tab and in the Config Vars section under the Reveal Config Vars menu you will be able to insert all your local Environment Variables.

  • When you are using a Heroku Postgres database you are given a DATABASE_URL that now you can use to connect your express server to. This URL is a replacement of the current PG credentials that you have on your local environment variables file.

  • Depending on the frameworks or programming languages that you use you need to configure the db accordingly 👉 Documentation

  • After you updated the code accordingly save the code and push it up to GitHub. If you enabled Automatic deploys the app will be automatically re-deployed.

  • If you go to Settings tab under Domains section you will be able to find the live url of your app.

Contributors ✨


Freshta Ebrahim


Valentina Militaru


Carl McIntosh


Jon Owens

About

A web app that the School of Code bootcampers can use in order to document their mentorship experience.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published