Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add release readme draft #36

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 47 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,63 @@
# Women Techmakers Berlin
# Women Techmakers Berlin App

Meetup Assistant for Women Techmakers Berlin events :robot:
### Women Techmakers Berlin
Women Techmakers is a global Women Techmakers run by Google. All our events are free of charge, we are open not only to women, but to everyone who respects Berlin's code of conduct https://berlincodeofconduct.org

Our app fetches Meetup Events via Meetup API from https://www.meetup.com/Women-Techmakers-Berlin/ and displays the events including venue and description details in a practical way. It also provides info about the community, usefel links to our blog and social media.
You can also check out the companies that have been supporting and contributing to Berlin's tech scene being diverse and inclusive!
### Meetup Assistant for Women Techmakers Berlin events :robot:
This app was written as a learning project to give a practical overview over our events including:

- programming courses
- career advice
- workshops on technical topics and soft skills
- talks with inspirational speakers

### What can I find here

Our app fetches Meetup Events via Meetup API from https://www.meetup.com/Women-Techmakers-Berlin/ and displays the events including venue and description details as a clickable list.

#### Events screen

<img src=“https://TODO.png” width=“350"/>

#### Info about the community

<img src=“https://TODO.png” width=“350"/>

#### Links to our blog and social media.

<img src=“https://TODO.png” width=“350"/>

#### Collaboration partners

Companies that have been supporting us and thus contributing to Berlin's tech scene becoming more diverse and inclusive!

<img src=“https://TODO.png” width=“350"/>

#### Community reviews

As a bonus feature, user can save notes. [WIP]
<img src=“https://TODO.png” width=“350"/>

#### Contributions and feedback

<img src=“https://TODO.png” width=“350"/>

#### Contributor's Guide

# Contributor's Guide
As soon as you started working on some issue from this project: https://github.com/WTMBerlin/WTMBApp/issues, put the `in progress` label on it and change the status to `done` after it is ready.
You can also assign yourself to the ticket if you want to commit implementing it.

Learning project crafted with love and Jetpack components :rocket:
We want to maintain a Kotlin codebase. Feel free to make pull requests, add issues or comments! 👨‍💻 👩‍💻

Aim to write nice code
Aim to write nice commits :tulip:
Aim to add tests
Some of the features are marked with `good first issue`. As this is a community app, I would be very happy to see the community members contributing.

[WIP] work in progress
General rule: aim to write nice code, commits. :tulip:

Protip: this app could be easily forked and adjusted for your community if you are present on Meetup :octopus:
more details: https://github.com/WTMBerlin/WTMBApp/blob/master/CONTRIBUTING.md

# License
### License

Copyright Women Techmakers Berlin Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down