ninadepina / bloktech

A platform designed to help foster pets find their new home.

👋 Welcome to Pawfinder: adopt a pet!

A platform designed to help foster pets find their new home. The concept is like a tinder for (foster) pets and (potential) owners. Shelters can sign up pets. Users (potential owners) can start swiping on the pets. When they see a pet they like, or dislike them. All the liked dogs will be shown in a list, that can later be refound. You can chat with the shelters of your liked pets and you will be provided with more information. I will be making a signup/login feature for this application.

---

📝 Installation

A code editor is needed to continue.

Install NODE.js

• Install Node.js
• Open your terminal, and type node install in your terminal
• To check if Node.js is installed, type node --version

Install GIT

• Open your terminal, and type git install in your terminal
• To check if Node.js is installed, type git --version

Configure GIT and Github

Connect GIT and GitHub in your terminal. This can be down by typing the following code into your terminal:

$ git config --global user.name "username here"
$ git config --global user.email "email here"

Clone repo

Download this project and open it with your code editor. Open your terminal on the path you want to download this repository on and type the following code in your terminal:

$ git clone https://github.com/ninadepina/bloktech.git

Install the dependencies

Install all the needed dependencies:

$ cd bloktech
$ npm install

Run the code

Go to the repository in the terminal and run the project:

$ cd bloktech
$ npm run start

Test the feature: http://localhost:3000/

Connect to a database

I personally use MongoDB, use their guide to set up your own connection.

---

🤖 Dependencies

The following dependencies are being used:

• BCrypt - for hashing passwords.
• Body-parser - to fish out data from forms.
• Dotenv - to securely store credentials.
• Express - used for its middleware and routing.
• Express-flash - define a flash message and render it without redirecting the request.
• Express-handlebars - a templating engine.
• Express-session - provides sessions to store user session data for persistency.
• Mongoose - object modeling tool for MongoDB.
• MongoDB - as database.
• NodeJS - to execute JavaScript code outside a web browser.
• Nodemon - automatically restarts the localhost when it detects file changes.
• Passport + Passport-local - authentication middleware for Node.js.

---

📝 License

MIT © Nina Vens