GDSC LPU - blog

Browse programming tutorials and articles written by GDSC LPU team.

View Example · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact

Built With

• Next.js
• Chakra UI
• Hygraph (Previously GraphCMS)

Tools And Technologies Used

• BeyondWords - Audio
• Coil - Web monetization
• Google Analytics
• Google AdSense
• Giscus - A comments system powered by GitHub Discussions.
• Netlify

(back to top)

Getting Started

Setup project locally for development.

Note [Important] These instructions are for development purposes only. Follow this guide to set up your own instance of this blog.

Prerequisites

Hygraph project set up

• Create or sign in to your Hygraph account.
• Click the button below to clone the Hygraph project.

• Create or sign in to your Cloudinary account.
• Follow this guide to install Cloudinary UI extension in Hygraph.

Blog set up

• npm

  npm install npm@latest -g

• Create .env.local file at the root level of the project and copy env variables from .env.example file. You need to fill atleast these three variables for development purpose.

  NEXT_PUBLIC_HYGRAPH_CONTENT_API_URL=
  NEXT_PUBLIC_HYGRAPH_AUTH_TOKEN=
  NEXT_PUBLIC_CLOUDINARY_CLOUDNAME=

Installation

1. Fork the repo
2. Clone the repo

   git clone https://github.com/[YOUR_USERNAME]/[YOUR_FORKED_PROJECT_NAME].git

3. Install the dependencies

   yarn

4. Start the development server

   yarn dev

5. Your project will be running at http://localhost:3000

(back to top)

Or

With Docker

1. Fork the repo
2. Clone the repo

   git clone https://github.com/[YOUR_USERNAME]/[YOUR_FORKED_PROJECT_NAME].git

3. Build the image

   docker-compose build

4. Run docker image

   docker-compose up

5. Your project will be running at http://localhost:3000

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 for more information.

(back to top)

Contact

Twitter - @gdsclpu

Project Link: https://github.com/RakeshPotnuru/blog

Status - status.gdsclpu.live

(back to top)