Joaquim09Castro/TODO_app

TODO APP

TODO App made with express & sqlite3
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

TODO app made as part of the Resilia Web Development course, to train express use.

Built With

• Express
• node-postgres

Getting Started

• You can have the usage experience of this application through it's heroku instance here.

• For running this on your local machine, follow these steps.

Prerequisites

• Node.js

Node is a runtime built to develop the application's back end in JavaScript language.

You can search for your preferable form of download here.

• A Postgres database

You can use a database located on your own machine.

or

Use a database from a hosting service provider (the heroku instance of this app uses ElephantSQL)

Installation

1. Clone the repo

git clone https://github.com/Joaquim09Castro/TODO_app.git

2. Install NPM packages

npm install

---

Usage

1. Set the database.js file to use your database:

// Option 1. Set the value directilly to the connection string value
const databaseURL = "YOUR_DATABASE_CONNECTION_STRING";

// Option 2. Install the dotenv node package and set the DATABASE_URL variable value inside it
DATABASE_URL="YOUR_DATABASE_URL"

2. On your computer's terminal, run the code

node src/config/database/tableCreation.js

3. Run the code

npm start

to initialize the application on your machine.

4. Use the Port number the application gives you and go to

http://localhost:(PORT_NUMBER)

You may set a PORT value in your .env file

By default the app will use it's value.

If there is no value for PORT in it, the app will use Port 9000

---

Roadmap

See the open issues for a list of proposed features (and known issues).

---

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

---

License

Distributed under the MIT License. See LICENSE for more information.

---

Contact

Joaquim Rodrigo Moraes de Castro - joaquimcastro2909@gmail.com

Project Link: https://github.com/Joaquim09Castro/TODO_app