Giter Club home page Giter Club logo

elmejdki / bucket-list Goto Github PK

View Code? Open in Web Editor NEW
2.0 1.0 0.0 483 KB

This project is kind of like a todo list but it's a little bit different cause this is a bucket list a list that people put in what they wish to do and from now and then they pick one wish to work on or achieve it, this project help users do the same thing by saving there wishes and help them there next adventure or wish to work on or achieve. for now it's a small application but I'm sure to make it bigger on the future.

HTML 3.04% JavaScript 63.91% SCSS 33.04%

bucket-list's Introduction

Bucket List

This project is kind of like a todo list but it's a little bit different. Because this is a bucket list a list that people put in thier wishes to do and from now and then they pick one wish to work on or achieve. This project help users do the same thing by saving there wishes and help them pick there next adventure (or wish). For now it's a small app but I'm sure I will make it bigger on the future, depends on the users feedback.

screenshot

Built With

  • ReactJS,
  • SCSS,
  • webpack,
  • babel

Live Demo

Live Demo

Getting started

Prerequisites

In order to have this project up and running you will need:

  • NodeJS 10+

Setup

First, you need to clone this project using one of the links above, using this command:

git clone RESPOSITRY_LINK

Then you should run: npm install

And afterward, you supposed to run: npm run serve, to run the project in your local machine.

Then head to the localhost on port 3030 https://localhost:3030

Congrats the project is fully working.

Deployment

For deployment, I used GitHub pages, but as you see my project is full of files and the index.html file is inside the build/ folder, so in order to deploy using GitHub pages we need to put the index.html file in the root of the repository, in order to do this we will use a simple trick, please follow the commands below if you want to deploy on your own repository:

  • If you have the build/ folder declared inside the .gitignore file please remove it from there.

  • run npm run build to generate the build folder.

  • then make sure that git knows about your subtree, using this command:

    git add build && git commit -m "Initial build subtree commit"
    
  • after that use subtree push to send it to gh-pages branch in GitHub:

    git subtree push --prefix build origin gh-pages
    

    Now you have finished you can check the link to GitHub pages you will find your project deployed there. you can find the link on the repository settings page.

Author

๐Ÿ‘ค Zakariae El Mejdki

๐Ÿค Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a โญ๏ธ if you like this project!

๐Ÿ“ License

This project is MIT licensed.

bucket-list's People

Contributors

elmejdki avatar

Stargazers

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