Skip to content

nouvelle/coffee-time

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

55 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

You can save the URLs you want to read later and read them later.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published