Skip to content

techlifejournal/techlifejournal

Repository files navigation

Description

A platform where tech enthusiasts from all over the world can come together to read, share, and learn about the latest trends, developments, and innovations in the tech industry. A place where anyone can contribute their knowledge and expertise, and where everyone can benefit from the wisdom of the community.

Hacktober2023

contributions welcome

Getting Started

These instructions will provide you with the steps necessary to set up a local copy of the project for development and testing purposes.

Prerequisites

  • Node.js
  • npm or yarn

Built With

  • Next JS - framework built on top of Node.js enabling React based web applications functionalities such as server-side rendering and generating static websites.
  • Tailwind CSS - a utility-first CSS framework for rapidly building custom user interfaces

Running the site

  • Fork and Clone the repository
$ git clone https://github.com/<your_github_username>/techlifejournal.git
$ cd techlifejournal
  • Install necessary packages
$ npm install
  • Setup .env file
URL=http://localhost:3000
BACKEND_URL = https://api-techlifejournal.herokuapp.com/api/
  • Start the webserver
$ npm run dev
# or
$ yarn dev
  • Output
You can now view the site in the browser.

  > next@0.1.0 dev
  > next dev
  ready - started server on 0.0.0.0:3000, url: http://localhost:3000
  info  - ready on http://localhost:3000
Note that the development build is not optimized.
To create a production build, use npm run build.
  • Open the website in your browser

Contributing

If you have the passion and the skills to contribute to this project, we would be grateful for your service. Contributing to open source projects is a great way to learn more about social coding on GitHub, get introduced to new technologies and their ecosystems, and develop the skills to make constructive, helpful bug reports, feature requests, and pull requests.

How to make a clean pull request

  • Create a personal fork of the project on Github.
  • Clone the fork on your local machine. Your remote repo on Github is called origin.
  • Add the original repository as a remote called upstream.
  • If you created your fork a while ago be sure to pull upstream changes into your local repository.
  • Create a new branch to work on! Branch from development if it exists, else from master.
  • Implement/fix your feature, comment your code.
  • Follow the code style of the project.
  • Add or change the documentation as needed.
  • Squash your commits into a single commit with git's interactive rebase. Create a new branch if necessary.
  • Push your branch to your fork on Github, the remote origin.
  • From your fork open a pull request in the correct branch. Target the project's development branch if there is one, else go for master!
  • If the maintainer requests further changes just push them to your branch. The pull request will be updated automatically.
  • Once the pull request is approved and merged you can pull the changes from upstream to your local repo and delete your extra branch(es).

And last but not least: Always write your commit messages in the present tense. Your commit message should describe what the commit, when applied, does to the code – not what you did to the code.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details