Skip to content

Commit

Permalink
feature:add badges to Readme [Starts #13]
Browse files Browse the repository at this point in the history
  • Loading branch information
@beblicarl
beblicarl committed Jul 21, 2022
1 parent 684f726 commit e6d825c
Showing 1 changed file with 224 additions and 49 deletions.
273 changes: 224 additions & 49 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
<!--PROJECT SHIELD-->

[![Node.Js][nodejs-shield]][nodejs-url]
[![Express.Js][expressjs-shield]][expressjs-url]
[![Jest][jest-shield]][jest-url]
[![PostgreSQL][postgresql-shield]][postgresql-url]
[![Json Web Token][jsonwebtoken-shield]][jsonwebtoken-url]
[![Travis CI][travisci-shield]][travisci-url]
[![Heroku][Heroku-shield]][heroku-url]
[![Prettier][prettier-shield]][prettier-url]
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Issues][issues-shield]][issues-url]
![2022][2022-shield]

## Teamwork

## Description
Expand All @@ -7,80 +22,240 @@ Teamwork is an ​ internal social network for employees of an organization. The
application is to facilitate more interaction between colleagues and promote team bonding.
An in-depth paragraph about your project and overview of use.

## Getting Started
## Content
- [Overview](#overview)
- [Deployment](#deployment)
- [Built With](#built-with)
- [How to Contribute](#how-to-contribute)
- [First Time](#first-time)
- [Returning](#returning)
- [Collaborators](#collaborators)
- [Product Managers](#product-managers)
- [Credit](#credit)

### Dependencies
## Overview

- npm, node, postgress, are needed before installing program.
### Deployment

### Installing
[Teamwork]() is hosted on [Heroku](https://id.heroku.com/login).

2. Clone the repo
```sh
git clone https://github.com/your_username_/Project-Name.git
```
3. Install NPM packages
```sh
npm install
```
4. Enter your API in `config.js`
```js
const API_KEY = 'ENTER YOUR API'
### Built With
1. Server-side Framework: ​Node​/​Express
2. Linting Library: ​ESLint
3. Style Guide: ​Airbnb
4. Testing Framework: ​Jest
5. Database: ​PostgreSQL
6. Continuos Integration : Travis CI
7. Gif Storage: Cloudinary

## How to Contribute

### First time

- Dependencies
<p> npm, node, postgress, are needed before installing program </p>
- Clone the project repository
- <p>Clone the repository locally on your computer's terminal</p>

```
git clone https://github.com/tbf-challenge/teamwork-be.git
```
- Install NPM packages

```
npm install
```

- Enter your API in `config.js`
```js
const API_KEY = "ENTER YOUR API";
```

<p align="right">(<a href="#top">back to top</a>)</p>

### Executing program
- Executing program

1. `npm start`
Runs the app in the development mode.\
`npm start`
Runs the app in the development mode.

The page will reload when you make changes.\
The page will reload when you make changes.
You may also see any lint errors in the console.

2. `npm test`
Launches the test runner in the interactive watch mode.\
### Returning

## Help
To begin contributing to this project,

Any advise for common problems or issues.
- Create a branch of feature you will be working on :

```
command to run if program contains helper info
```
```
git checkout -b [feature-branch]
```

## Authors
- Update your name on the [contributors](#contributors) list on the project's README file
Contributors names and contact info
- Write your code
ex. Dominique Pizzie
ex. [@DomPizzie](https://twitter.com/dompizzie)
- Add your code to Git locally and commit changes to your remote repository :
## Version History
```
git add .
- 0.2
- Various bug fixes and optimizations
- See [commit change]() or See [release history]()
- 0.1
- Initial Release
git commit -m "commit-message-here"
```
### Built With
- Sync your code before pushing
This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
```
git pull upstream dev
```
- [![Next][next.js]][next-url]
- Push your feature branch to repository
<p align="right">(<a href="#top">back to top</a>)</p>
## License
```
git push -u origin "feature-branch-name"
```
- Open pull request (PR) on GitHub to merge your feature branch into your dev branch
- Submit a new PR to merge your updated dev branch into the upstream dev branch on GitHub
> please resolve conflicts that arise before making a PR
- You have successfully contributed.
## Contributors
Teamwork backend was built by 9 people
#### **Product Manager**
1. <a href="#">Aderayoo</a>
2. <a href="#">Azeez Akande</a>
#### **Developers**
3. <a href="https://github.com/jakazzy">Jakazzy</a>
4. <a href="https://github.com/beblicarl">Carl Bebi</a>
5. <a href="#">Saviour Dagadu</a>
6. <a href="#">Kemi Adedoyin</a>
7. <a href="#">Abiodun Ayorinde</a>
8. <a href="#">Alexanda Manu</a>
9. <a href="#">Adeniyi Akinwale</a>
## Credit
This project is facilitated by [TBF](https://github.com/tbf-challenge)
This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details
- Inspiration, code snippets, etc.
## Acknowledgments
- [awesome-readme](https://github.com/matiassingers/awesome-readme)
- [PurpleBooth](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2)
- [dbader](https://github.com/dbader/readme-template)
- [zenorocha](https://gist.github.com/zenorocha/4526327)
- [fvcproductions](https://gist.github.com/fvcproductions/1bfc2d4aecb01a834b46)
<!-- -->
<!-- ### Dependencies -->
<!-- -->
<!-- - npm, node, postgress, are needed before installing program. -->
<!-- -->
<!-- ### Installing -->
<!-- -->
<!-- 2. Clone the repo -->
<!-- ```sh -->
<!-- git clone https://github.com/your_username_/Project-Name.git -->
<!-- ``` -->
<!-- 3. Install NPM packages -->
<!-- ```sh -->
<!-- npm install -->
<!-- ``` -->
<!-- 4. Enter your API in `config.js` -->
<!-- ```js -->
<!-- const API_KEY = "ENTER YOUR API"; -->
<!-- ``` -->
<!-- -->
<!-- <p align="right">(<a href="#top">back to top</a>)</p> -->
<!-- -->
<!-- ### Executing program -->
<!-- -->
<!-- 1. `npm start` -->
<!-- Runs the app in the development mode.\ -->
<!-- -->
<!-- The page will reload when you make changes.\ -->
<!-- You may also see any lint errors in the console. -->
<!-- -->
<!-- 2. `npm test` -->
<!-- Launches the test runner in the interactive watch mode.\ -->
<!-- -->
<!-- ## Help -->
<!-- -->
<!-- Any advise for common problems or issues. -->
<!-- -->
<!-- ``` -->
<!-- command to run if program contains helper info -->
<!-- ``` -->
<!-- -->
<!-- ## Authors -->
<!-- -->
<!-- Contributors names and contact info -->
<!-- -->
<!-- ex. Dominique Pizzie -->
<!-- ex. [@DomPizzie](https://twitter.com/dompizzie) -->
<!-- -->
<!-- ## Version History -->
<!-- -->
<!-- - 0.2 -->
<!-- - Various bug fixes and optimizations -->
<!-- - See [commit change]() or See [release history]() -->
<!-- - 0.1 -->
<!-- - Initial Release -->
<!-- -->
<!-- ### Built With -->
<!-- -->
<!-- <!-- This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples. --> -->
<!-- -->
<!-- - [![Next][next.js]][next-url] -->
<!-- -->
<!-- <p align="right">(<a href="#top">back to top</a>)</p> -->
<!-- ## License -->
<!-- -->
<!-- This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details -->
<!-- -->
<!-- ## Acknowledgments -->
<!-- -->
<!-- Inspiration, code snippets, etc. -->
<!-- -->
<!-- - [awesome-readme](https://github.com/matiassingers/awesome-readme) -->
<!-- - [PurpleBooth](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2) -->
<!-- - [dbader](https://github.com/dbader/readme-template) -->
<!-- - [zenorocha](https://gist.github.com/zenorocha/4526327) -->
<!-- - [fvcproductions](https://gist.github.com/fvcproductions/1bfc2d4aecb01a834b46) -->
Inspiration, code snippets, etc.
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
- [awesome-readme](https://github.com/matiassingers/awesome-readme)
- [PurpleBooth](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2)
- [dbader](https://github.com/dbader/readme-template)
- [zenorocha](https://gist.github.com/zenorocha/4526327)
- [fvcproductions](https://gist.github.com/fvcproductions/1bfc2d4aecb01a834b46)
[contributors-shield]: https://img.shields.io/badge/contributors-343434?style=for-the-badge
[contributors-url]: https://github.com/tbf-challenge/teamwork-be/graphs/contributors
[forks-shield]: https://img.shields.io/badge/forks-343434?style=for-the-badge
[forks-url]: https://github.com/tbf-challenge/teamwork-be/network/members
[issues-shield]: https://img.shields.io/badge/issues-343434?style=for-the-badge
[issues-url]: https://github.com/tbf-challenge/teamwork-be/issues
[2022-shield]: https://img.shields.io/badge/2022-000000?style=for-the-badge
[eslint-shield]: https://img.shields.io/badge/eslint-3A33D1?style=for-the-badge&logo=eslint&logoColor=white
[eslint-url]: https://airbnb.io/javascript/
[jest-shield]: https://img.shields.io/badge/Jest-C21325?style=for-the-badge&logo=jest&logoColor=white
[jest-url]: https://jestjs.io/
[postgresql-shield]: https://img.shields.io/badge/PostgreSQL-316192?style=for-the-badge&logo=postgresql&logoColor=white
[postgresql-url]: https://www.postgresql.org/
[expressjs-shield]: https://img.shields.io/badge/Express.js-000000?style=for-the-badge&logo=express&logoColor=white
[expressjs-url]: https://expressjs.com/
[jsonwebtoken-shield]: https://img.shields.io/badge/JWT-000000?style=for-the-badge&logo=JSON%20web%20tokens&logoColor=white
[jsonwebtoken-url]: https://jwt.io/
[nodejs-shield]: https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white
[nodejs-url]: https://nodejs.dev/
[travisci-shield]:https://img.shields.io/badge/travis_CI-3EAAAF?style=for-the-badge&logo=travisci&logoColor=white
[travisci-url]:https://www.travis-ci.com/
[heroku-shield]:https://img.shields.io/badge/Heroku-430098?style=for-the-badge&logo=heroku&logoColor=white
[heroku-url]:https://id.heroku.com/
[prettier-shield]:https://img.shields.io/badge/prettier-1A2C34?style=for-the-badge&logo=prettier&logoColor=F7BA3E
[prettier-url]:https://prettier.io/

0 comments on commit e6d825c

Please sign in to comment.