Skip to content

Latest commit

 

History

History
150 lines (127 loc) · 7.88 KB

README.md

File metadata and controls

150 lines (127 loc) · 7.88 KB
Raw

Welcome to Digital Diary

Have you ever wanted a personal space on the web to write your personal thought between different categories?

No?

Okay, now you do!

Digital diary is the best online diary that you never asked for! Help us build a great open source application by contributing to this app!

If you want to contribute to our great online diary you should read through all this document!

Join the discord server to monitor the repo!

Click the image to join the server

Yup! That's right, we've got our own personal discord server >:) and it allows us to monitor the repo! Bwahahah.
Okay, time to get serious. Let me talk to you about the server:

Rules

  • Do not spam the channels
  • Do not send messages on any channel where the Pokebots send notifications unless completely necesarry. Remember that the main focus of that server is monitoring updates!

Bots

The server contains five unique pokemon bots with their unique personality (or at least an attemp of giving them their own personality). Those are:

  • Mudkip Bot: Notifies you about a new pull request
    Image of new pull request notification
  • Chikorita Bot: Notifies you about a new Front-End Issue!
    Image of new FrontEnd Issue notification
  • Torchic Bot: Notifies you about a new Back-End Issue!
    Image of new BackEnd Issue notification
  • Totodile Bot: Notifies you about a new Documentation Issue!
    Image of new Documentation Issue notification
  • Jirachi Bot: Notifies you about a new Wishlist Issue!
    Image of new Wishlist Issue notification

They work thanks to Github Actions!

Contributing to the repository

Creating an Issue

When creating an issue it is important that you add the corresponding label into it to allow everyone whose on the discord server know what the issue is! You must use the following labels:

  • Frontend: stuff related to...well the front-end
  • Backend: same as above but with the back-end
  • Documentation: any issue related to the design of the system, UI / UX, readme, etc.
  • Wishlist: anything that does not enters in the above categories that you think that is something that our amazing project should have!

Making code changes

  • Fork and clone the repository git clone https://github.com/ShrillShrestha/digital-diary
  • Create a branch git checkout -b "<your_branch_name>"
  • Make your changes in that branch
  • Test your changes
  • Add and commit your changes with git add . && git commit -m "<your_commit_message>"
  • Then push the changes into your branch git push origin branch_name
  • Now you can create a PR using that branch in our repository.

Pull Requests

We all want to create some pull requests that get merged, but before you start working on it, please attach to this rules!

  • Make the name descriptive
  • Prove a summary of the files changed on the description of the PR!
  • Provide constructive feedback where it applies.
  • If it does not get approved please don't get mad, it's a great learning experience and everyone is welcome to contribute! Read the feedback and keep trying! :)

Some Useful tips

Sometimes the main branch of our repo might be updated since the last time you forked it. It might create conflicts while merging the PR. In such case:

  • Add out repo as your upstream repo using git remote add upstream https://github.com/ShrillShrestha/digital-diary.
  • Checkout to your main and pull the lastest changes from the upstream with git pull upstream master.
  • If you want, you can push the latest main branch to update your origin's main with git push origin main.
  • Checkout to your branch, where you made the changes.
  • Rebase your branch to the latest main branch with git rebase master
  • Resolve any conflicts, if any.
  • Push the latest change to your origin.

Documentation

System Design

UI Design

  • Landing Page
    landing_page

  • Sign In Page
    signIn

  • Sign Up Page
    signup

  • Categories List
    categoriesList

  • Create Category Form
    createCategory

  • Entry List Page
    entriesList

  • Entry Detail Page
    entry_detail

  • Create Entry Page
    creatEntry

  • Error Page
    error

Technologies Used

  • React
  • AWS Amplify framework
  • GraphQL
  • DynamoDB
  • React Bootstrap
  • GitHub Actions

Prerequisites

  • Node.js v12.x or later
  • npm v5.x or later
  • git v2.14.1 or later
  • AWS account and aws amplify cli. You can follow this, if you have to configue your cli.

How to test the app locally?

  • Clone the repo on your local using git clone https://github.com/ShrillShrestha/digital-diary
  • Go to the project directory using cd digital-diary
  • Run npm install to install all the dependencies
  • Once the cli is configured, run amplify init
  • When the prompt asks you to use existing environment, select no. This will prompt you make make your dev environment
  • Name your environment, select your ide and use your AWS profile to set up your dev environment
  • Run amplify add auth to add your own authentication system
    • Select default configuration
    • Select your preference of sign in method
    • Select No, I am done when prompt to configure advance settings
  • Run amplify add api
    • Select GraphQL
    • Provide your name for the api
    • Choose Amazone Cognito User Pool for authorization type
    • If asked to configure advance setting, select no
    • Select yes when asked for annotated GraphQL schema
    • Give the path for your GraphQL schema. i.e ./amplify/backend/api/schema.graphql
  • Run amplify push to push changes to the aws cloud
  • Once the everything is done, run npm start, and there is your digital personal diary. :)

Contributors: