Skip to content

th3N0m4d/travel-blog

Repository files navigation

Forks Stargazers Issues MIT License LinkedIn


Logo

Travel Blog

Travel Blog is a simple and yet modern blogging website which uses modern concepts such as SSR (Server Side Rendering), semantic tags, and clound functions.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

This project's main goal is to explore the myriad of technologies and approaches catered to the blogging community.

My main focus will be on using modern technologies such as Nextjs and AWS services, such as Cloud Functions.

The second goal of this project is to learn about the unique challenges posed by this kind of app, i.e. making the website as SEO (Search Engine Optimization) friendly as possible, accessibility, performance and content management.

(back to top)

Built With

(back to top)

Getting Started

Please, follow the instructions below in order for your to be able to run and experiment with this project.

Prerequisites

  • npm
    npm install npm@latest -g

Installation

  1. Clone the repo
    https://github.com/th3N0m4d/travel-blog.git
  2. Install NPM packages
    npm install
  3. Run project locally
    npm run dev

(back to top)

Roadmap

New Features

  • Offline Mode
  • Collect User Analytics
  • Make Website SEO Friendly
  • Add to Home Screen
  • Ability To Create Blogs
  • Comment Management With Disqus
  • Contact Me Page
  • About Me Page
  • CSS Theme Based On OS'

Enhancements

  • Replace Custom CSS With Tailwind
  • Simplify Imports With Module Aliases
  • Improve README File Wording
  • Use Ramda

Bugs

  • Blog Posts Are Not Correctly Laid Out

QA

  • Integration Tests With TestCafe:
  • Enable Test Coverage With Coveralls
  • Handle Rendering Errors With Error Boundary

Deployment Pipeline

  • Ability To Preview Deployments

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 'feat: 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

Edie - edielton.dantas@hotmail.com

Project Link: https://github.com/th3N0m4d/travel-blog

(back to top)

Acknowledgments

The website's look and feel was based on a free Wordpress template developed by the talented Sal from Wow Themes.

Click here to see more from Sal.

(back to top)