/spacetravelling

An awesome Blog Model, using Next.js, Prismic CMS and Utteranc!

Primary LanguageTypeScript

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

SpaceTravelling

An awesome Blog Model, using Next.js, Prismic CMS and Utteranc!
Explore the docs »

Report Bug · Request Feature

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

About The Project

Product Name Screen Shot

An awesome Blog Model, using Next.js, Prismic CMS and Utteranc.

Features:

  • Get posts from Prismic CMS API
  • List the blog posts with pagination
  • On the post page, go to previous and next posts
  • Add comment on post page using Utteranc

Built With

Getting Started

Prerequisites

  • npm

    npm install npm@latest -g

  • yarn

    npm install --global yarn

Installation

  1. Get a free API Key to Primic CMS (check the list on .env.sample)
  2. Create the file .env.local on your project and set all the API Keys
  3. Clone the repo 
    git clone https://github.com/jennifertakagi/spacetravelling.git
  4. Install packages 
    yarn | npm install
  5. Start the project on root file 
    yarn | npm dev

Usage

  • Home Page with the Posts' list

  • Post Page

  • Post Page with the comment box

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

Jennifer Takagi - @jennitakagi

Acknowledgements