Giter Club home page Giter Club logo

journal-app's Introduction

๐Ÿ“ My Journal

My Journal image

๐Ÿ’ญ What is My Journal?

This is a lightweight journaling and note saving cloud application. The notes are saved on the cloud and can be accesed from any device at any moment.

You can read and download the full application document here. It has all the technical and functional information but is in Spanish though!

๐ŸŒ User features

There are some key features that the user will enjoy that are implemented on My Journal:

  • Lightweight and fast
  • Login with Google and Email/Password
  • Full notes CRUD (Create, Read, Update, Delete)
  • Image uploading
  • Responsive design (it has to be fixed)
  • Intuitive and clean design

๐Ÿ“š Tech stack and libraries

Some of the tools used for this project are:

  • React - The main tool used for this app. A JavaScript framework to develop scalable and robuts frontend applications.
  • Redux - A react library created to control application state. This is one of the key implementations.
  • Firebase - A backend modular tool made by Google. Im using the authentication module and the Firestore module for the database.
  • MaterialUI - The library used for the app design. It's entirely based on the Material design by Google.
  • Vite - A toolkit to create and deploy easily Javascript applications.

๐Ÿ‘จโ€๐Ÿ’ป Dev features

There are some features and design decisions that can be appreciated by developers. This project was made to learn how to properly design a React app:

  • A Redux thunks based design
  • Form validation and control through custom hooks
  • Private routes
  • Custom Firebase providers
  • Multiple file upload and validation
  • Redux store based in slices and made with clean architecture
  • Ease to add new themes to the applicaiton
  • Keep login between page refresh
  • Full CRUD

๐Ÿ“‚ Download

You can download and deploy the application manually or using Docker! For both options you must create a Firebase app with user authentication and Firestore enabled and replace your Firebase credentials on this file.

๐Ÿšง Work in progress! Come back later ๐Ÿšง

journal-app's People

Contributors

alesbe avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.