Skip to content

Latest commit

 

History

History
98 lines (59 loc) · 3.91 KB

README.md

File metadata and controls

98 lines (59 loc) · 3.91 KB
Raw

TechCreators

A website to list tech twitter creators, across the world.

Languages/Tools

HTML5 CSS3 JavaScript

👩🏽‍💻 Demo

Check out the website: TechCreators

👇🏽 Prerequisites

Before installation, please make sure you have already installed the following tools:

🛠️ Installation Steps

  • Fork the project. Click on the icon in the top right to get started.

  • Use these commands in your git bash to make a clone of the project in your pc.

SSH Github Docs

$ git clone git@github.com:username/TechCreators

GitHub CLI

$ gh repo clone username/TechCreators

HTTPS

$ git clone https://github.com/username/TechCreators
  • Navigate to the project directory:
cd TechCreators

🔥 Add your profile

  1. Fork the project:
  • Click the gray Fork button in the top right of this page. This creates your copy of the project and saves it as a new repository in your github account
  1. Create a New Branch:
  • On your new repository's page, click the gray main button in the upper left to reveal a dropdown menu.
  • Enter the name of your new branch in the text box. (Branch names usually make a reference to what is being changed. Example: profileAdd).
  • Click on Create branch <new branch name> and this will automatically take you to your new branch. You can make edits on the main branch, but this may cause issues down the line. Best practice is to create a new branch for each separate issue you work on. That way your main branch remains in sync with TechCreators main branch.
  1. Navigate to file:
  • Navigate to the profile/profile.json file.
  1. Edit:
  • On the top right of the JSON file, click on the pencil icon to edit the file by adding your image, name and username.
  • You can add JSON object wherever you want in the file, it will automatically arrange according to alphabetical order.
  • After editing the JSON file, add a commit message and click on the green button saying "Commit Changes". Make sure you have selected the branch you have created.
  1. Raise a Pull Request:

🚀 Running locally

To run locally, just cd into the project and run the following commands to run node modules and serve the website locally.

npm i
npm run start

🛡️ License

TechCreators is licensed under the MIT License - see the LICENSE file for details.

💪🏽 Contributors

Thank you so much all for spending your time to improve TechCreators. Keep shining ⭐

Contributors

🙏🏽 Support

This project needs a star️ from you. Don't forget to leave a star 🌟