Skip to content

Commit

Permalink
Update Readme and addes sceenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
riturajjain2000 committed Feb 8, 2021
1 parent 9fb6221 commit d3543fc
Show file tree
Hide file tree
Showing 6 changed files with 173 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .idea/.name

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

74 changes: 74 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Code of Conduct

### Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

### Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

### Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

### Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

### Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

### Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Contribution Guildelines

## Please follow these steps if you wish to contribute to Pick-A-Lot:

### Star the Repo!
<br>
<br>

1. Go through the Issues to see if, what you want is already in discussion.

2. Open a new Issue if you do not find the name you are looking for. Describe the feature request,additions you might want or anything clearly in the Issue message.

3. Mention in the Issue that you want to work on it.

4. Wait for the approval from the Maintainers of this project before startig to work on it.

5. Donot make changes to the main branch , else make a develop branch and commit changes there.

6. Make sure you code is properly formatted and does not contain any commented out code.

7. Create a pull request after making the changes and mention the Issue number that your pull request is related to.

8. Make the required changes if the reviewer asks for them.

9. That's it! Your pull request will be merged once everything seems okay.



72 changes: 70 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,70 @@
# Pick-A-Lot
App to list your workspace
# Pick-A-Lot - App to list your workspace

![GitHub forks](https://img.shields.io/github/forks/riturajjain2000/Pick-A-Lot)
![GitHub Repo stars](https://img.shields.io/github/stars/riturajjain2000/Pick-A-Lot)
<br>
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Open Source Love svg1](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
![contributions welcome](https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=flat-square)
![Maintenance](https://img.shields.io/maintenance/yes/2021)


<br>
<img align='center' src='https://github.com/riturajjain2000/Pick-A-Lot/blob/main/images/ss1.jpg'>
<br>
<img align='center' src='https://github.com/riturajjain2000/Pick-A-Lot/blob/main/images/ss2.jpg'>
<br>





## πŸ”₯ Features

πŸ“° List Places for renting and other purposes.

✨ Save favuorite places.

πŸš€ Chat directly with the owner and book the place.

πŸ”₯ Keep track of your listing along with a perosnalised profile section.

## πŸ›  Tech Used

-Android

-Kotlin

-MVVM clean architecture

-Firebase Realtime DB

-Firebase Firestore DB

[![forthebadge](https://forthebadge.com/images/badges/built-by-developers.svg)](https://forthebadge.com)
[![forthebadge](https://forthebadge.com/images/badges/uses-git.svg)](https://forthebadge.com)
[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com)



## Contribution Guidelines βš™οΈ
You can find our Contributing guidelines [here](https://github.com/riturajjain2000/Pick-A-Lot/blob/main/CONTRIBUTING.md).

## Code Of Conduct:

You can find our Code of Conduct [here](https://github.com/riturajjain2000/Pick-A-Lot/blob/main/CODE_OF_CONDUCT.md).

## License πŸ“

This project follows the [MIT License](https://choosealicense.com/licenses/mit/).



<br>
<br>
<h2 align="center">Made with ❀ by Rituraj Jain</h2>

<br>
<br>
<h2 align="center">If you liked the project don't forget to 🌟 and 🍽 the project.</h2>
Binary file added images/ss1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/ss2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d3543fc

Please sign in to comment.