Project Night Blog

The goal here is to create a fullstack blog style application built on Node, Express, and EJS.

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

Desktop Index View Desktop Login View Desktop Edit Profile View

Mobile index & Login Profile view Mobile index & Register Profile view Mobile index & Edit Profile view

(back to top)

Built With

• JavaScript
• Express
• EJS
• Express-session
• MongoDB
• Mongoosejs
• Node.js
• Passport.js
• Marked.js

(back to top)

Getting Started

To run the projects you will need to follow the instructions below. This will run a localhost version of the website.

Installation

1. Clone the repo:

   git clone https://github.com/LucasMERN/project-night-blog.git

2. Install NPM packages:

   npm install

3. Run LocalHost:

   npm run dev

(back to top)

Roadmap

Features

• Set up a basic blog structure
  • Add Layout based on figma - [x] Left Navbar - [x] Top Navbar - [x] Index Page - [x] Post view - [x] Profile view - [ ] Search view: Feature Update
• Set up Authentication system using Passport
• Routes
  • '/'
  • '/blog'
  • '/user'
  • '/login'
  • '/register'
• Set up a Database (MongoDB) using Model
  • post Completed with PR #11
    • create post
    • edit post
    • favorite post
    • bookmark post
    • [] pin post
  • users
    • username
    • password
    • email
• Darkmode toggle: Added with PR #10

Future

• Create User Profile pages
  • Edit Photo
  • Add/Edit Bio
  • Can use this for tooltips on hover in comment/Suggested follow sections
• Search Bar
• Filter Post Buttons
  • Popular (filter by Most Liked posts)
  • Authors Followed (filter by author)
  • Latest Posts (filter by CreateAt date)
• Trending Posts
• socket.io for DMs

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

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

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

(back to top)

Contact

• Lucas Winkler - @MERN_Man_Luke
• Matt Misko - @miskocodes

(back to top)

Acknowledgments

(back to top)