/notes-app

My own implementation of what a minimalistic notes app looks and feels like.

Primary LanguageJavaScript

Notes Web App (Full Stack Application)

Table of Contents

Overview

This project is a result of experimental thoughts of what the ideal notes app should feel and function like. It will continue to evolve and take different shapes and style, as I continue to redefine what the ideal notes app is to me. The goal is to create a notes application I am continuously happy to use and maintain.

Built With

  • React
  • Node & Express

Installation

  • After cloning the files, Navigate into the project folder (For you to have the file locally on your machine you will have to follow the steps below.)

  • To Install packages for the Client-side

      cd frontend

  • Install necessary dependencies.

      npm install

  • To Install packages for the server

      cd backend

  • Install necessary dependencies

      npm install

  • After a successful installation, you can now start up each part of the app.

  • In frontend and backend folder

      npm start

How To Contribute

  • Fork the repository
  • Clone and then open it up on your code editor git clone https://github.com/ImieboGodson/notes-app.git
  • Open terminal and set upsream branch: git remote add upstream https://github.com/ImieboGodson/notes-app.git
  • Pull upstream; git pull upstream dev
  • Create a new branch for the feature you are working on; git checkout -b feature-name
  • After making changes, stage all the changes you have made locally for a commit by running git add .
  • Commit your changes with a descriptive commit message; git commit -m "commit message"
  • Before you push to your changes always make sure that your branch is always up-to-date in other to avoid merge conflicts: git pull upstream dev
  • After making sure your branch is up-to-date, push the new changes to your new branch: git push origin your-current-branch-name
  • Create a pull request to the dev branch

Contact

Any feedback is always welcomed, if you feel there's somewhere/something I should have done better you can always reach out through my handles below. I am ALWAYS ready to learn and grow. You can also follow me to witness adventures through time ;).