GithubHelp home page GithubHelp logo

todo-app's Introduction

To-do list app with React and Firebase

This is a small app that connects to a firebase instance to allow the users to create a todo list with it's correspondant list items.

Initial configuration

To install the project you need to follow the next steps:

  1. Clone the repository
  2. Configure your firebase realtime database and auth settings in the firebase console
  3. Copy the connection object into a new file at src\components\Firebase\firebase.js, you can copy src\components\Firebase\firebase-connection-template.js and rename it to firebase.js with your firebase connection object
  4. Run 'yarn install', to install the project dependencies
  5. Run 'yarn start', to start the development deploy

There are more yarn notes at the end of this file.

Pages

The app hast six 'root' pages, that call all the components needed to provide the to-do list functionalities.

Landing page

It is accesible to all the users, even when they are not logged in, it only displays a text, you could add anything that you want all the people to see in this section.

landing

Sign In page

This page allows the user to sign in or create a new account. It uses the firebase auth API so aditional sign up methos can be used, such as a Google or Facebook account.

sign-in

It also has links to a create account page. In this versión of the app the user can choose to be an 'Admin' by activating the checkbox field, you should remove this and add it to another component, e.g. the admin page.

sign-up

Home page

The home page is a protected component that is only visible to logged in users, it displays the to-do list and it's items. You can add a new item with the text field at the bottom of the page, and edit or delete an existing one by using the correspondant button.

home

Account page

Another protected component, it allows the user to reset the password by sending an email with a link or by setting the password manually. This page also lets the user link or unlink other authentication methods.

account

Admin page

This page displays all the app users and has a link to a detail component that also allows to send a reset password link.

admin

user_detail


This project was created with Yarn and Create React App, so I will left the links and notes to the Yarn docs.


Getting Started with Create React App

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

yarn eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

yarn build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

todo-app's People

Contributors

jrobertorma 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.