Team-Berlin-React

Table of contents

• Overview
  • Product vision
• Built with
  • Live Demo
  • Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
  • Deployment
  • Continued development
  • Useful resources
• Authors
• Contributing
• Show your support
• Acknowledgments
• License

Overview

The SpaceYaTech Forum provides users with the opportunity to join communities, make posts, upvote other people's posts, comment on posts, downvote posts they don't like and report posts which don't abide by the community standards.

Product Vision

SpaceYaTech Forum is FOR: young africans interested in technology discussions in Africa WHO: want to find opinions and news about various topics in Africa THE: Space Ya Tech IS A web application THAT: gives a platform to young people to interact on different technology matters UNLIKE: other existing products which already exist in the market OUR PRODUCT: is open source and developed by the community for the community addressing the pain points of the African tech ecosystem. checkout product vision

Built With

!

Live Demo (if available)

Live Demo Link

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Setup

Fork the repo on GitHub to your personal account. Click the Fork button on the Team-Berlin-React page.

Clone the repository. Click the green "Clone or download" button and copy the url. Run git clone https://github.com/SpaceyaTech/Team-Berlin-React.git in your Terminal.

Install

Run npm install in your terminal. Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

Usage

Run npm start in your terminal. Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

Run tests

Run npm test in your terminal. Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

Deployment

See this section for more information: https://facebook.github.io/create-react-app/docs/deployment

🤝 Contributing

Contributions, issues, and feature requests are welcome!

1. Head over to issues tab and pick an issue that interest you.

2. Clone the repository to your computer. Click the green "Clone or download" button, and copy the url and type git@github.com:SpaceyaTech/Team-Berlin.git

3. Once you have done this, create a new branch. You should make a branch name that is short, descriptive, and unique. Some examples of good branch names are create-header-component, docs-cleanup, and fix-footer-component. Some examples of bad branch names are feature, fix, and patch. The branch name choice is not too important, so don't stress over it, but it is what people will use to reference your changes if they want to pull them down on their own computers to test them, so a good name will make it easier for others to understand what your branch does. In this example, the branch name is fix-footer-component.

To create the branch, run git checkout -b branch-name(replace branch-name with the branch name you chose). This will create a new branch and check it out. You can verify this with git status.

4. Make your changes and commit them. Once you have created your branch, make your changes and commit them. Remember to keep your commits atomic, that is, each commit should represent a single unit of change. Also, remember to write helpful commit messages, so that someone can understand what the commit does just from reading the message without having to read the diff.

For example, at the command line, this might look like

git add filename [filename ...]
git commit -m "your commit message"

5. Rebase your branch on pre-dev. Use the following command git pull origin --rebase pre-dev

6. Push up your changes. Do this by running git push origin branch-name

7. Make a pull request. Enter a descriptive title in the title field. This is very important, as it is what will show up in the pull request listing and in email notifications to the people in the repo. Pull requests with undescriptive titles are more likely to be passed by. If the pull request fixes an issue, I recommend putting the issue number in the pull request description, not the title. People generally do not know issues by number, so a pull request that is just titled "fix for issue #1234" is more likely to be passed by, as it is unclear what it does from the title.

If there is more description or discussion about the pull request than what fits in the title field use the description field.

If the pull request fixes an issue, you can add "fixes #1234" (replace 1234 with the actual issue number) in the pull request description. This exact format, "fixes #1234" is important, as it will cause GitHub to automatically close the issue when the pull request is merged.

Once you are done, click the "create pull request" button.

8. Pushing additional changes. Once you have created the pull request, it will likely be reviewed and some additional fixes will be necessary. Do not create a new pull request. Rather, simply make more commits to your branch and push them up as in steps 4, 5 and 6. They will be added to the pull request automatically.

• Check out on pull request guide

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration

📝 License

This project is MIT licensed.