Ali & Nas Travel Blog

Description

This project was developed as our final project FAC (Founders and Coders) (FAC30A) curriculum. It aims to provide a web platform for a for travels to blog about their experiences and as part of that experience we incorporated OpenAI into the project.

Techologies Used

As part of the project the technologies we settled on were:

Installation & Running Project

Please click the link below to copy the pathway for cloning the project:

   git clone https://github.com/fac30/ali-nas-travel-blog.git

Once cloned please install the Node packages:

    npm install

As part of the installation process Nodemon was installed to run the project locally, to start the server:

    npm start

The project is using Port 5096 due to port conflicts during development.

    http://localhost:5096/

How To Use The Project

Once installed copy the .env.example and change the name to .env, as this is the projects environment file.

Then go to:

    https://www.mongodb.com/atlas/database

Create a free account and follow the instructions to open a free database, as part of the set up process you will is issued with a Connection String to your API linking the project to you database where the blog posts and images will be stored. If you're new to the process follow the YouTube video below:

    https://www.youtube.com/watch?v=jXgJyuBeb_o

Once you have the MongoDB connection string paste it into the .env file next to MONGODB_URI=<INSERT_HERE>.

Create a random password of your own choice for JWT_SECRET=<INSERT_HERE>.

Finally for OpenAI create an account and then paste the API key into the following place OPEN_API_KEY=<INSERT_HERE>:

Documentation

    https://platform.openai.com/overview

YouTube Tutorial

Or alternatively follow this YouTube video:

    https://www.youtube.com/watch?v=aVog4J6nIAU

Once your up and running click on Login on the top right and then click Signup and create and account.

With the account setup go to MongoDB Atlas and in the collection for users find the account you created and change the role for your user to admin and you will have administrator access.

Having logged in you can create blog posts with images that are mandatory and you also have the option for OpenAI to create the blog post, you will have to create the title and upload the image but the context will be inserted by OpenAI.

Credits

The collaborators on this project are as follows:

• Ali GitHub repo
• Nas GitHub repo

Acknowledgements

• Bootstrap Official Documentation