Giter VIP home page Giter VIP logo

coffee-time's Introduction

This was created during my time as a student at Code Chrysalis.

Site clip for your Coffee Time โ˜•

You can check out the app on Heroku!

image image

  1. About
  2. Development
  3. Other command
  4. Technology used
  5. Future features
  6. Contributing
  7. License

About

If you use this app, you can save the URLs you want to read later and read them together later.
You can save what you have read, so you can read it immediately if you want to read it again.

Development

Follow this guide to set up your environment etc.

Database

This project assumes a Postgres database, naturally, this is not included in the package.json file, so must be installed separately.

If you are on Windows using WSL, this blogpost is very helpful.

Create a database called coffeetime.

Create a .config.js file in the project root with this format:

module.exports = {
  db: {
    client: "postgresql",
    connection: process.env.DATABASE_URL || {
      host: process.env.DB_HOST || "127.0.0.1",
      port: process.env.DB_PORT || 5432,
      database: process.env.DB_NAME || "coffeetime",
      user: "exampleUsername", // <= Your command line username
      password: "examplePassword", // <= Your command line
    }
  },
};

To clone and run this application, you'll need Git and Node.js (which comes with yarn) installed on your computer.
From your command line:

Downloading and installing steps

  1. Clone this repository
$ git clone https://github.com/nouvelle/coffee-time.git
  1. Go into the repository
$ cd coffee-time
  1. Install dependencies
$ yarn
  1. Create database, Run migrations and set up the database
$ yarn migrate
  1. Run the app
$ yarn start

Other command

  • To roll back migrations
$ yarn rollback
  • To insert test data
$ yarn seed

Technology used

This software uses the following open source packages: image

Future features

For now, you can see the site clip data.
I will be adding more function.

  • Save added data and read information into database.
  • Show the history of your reading.
  • Login function.
  • Interactive animations.

Contributing

Pull requests are welcome!! ๐Ÿ˜Š

License

MIT

coffee-time's People

Contributors

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