Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kammradt/lets-meet-client

πŸ’š A Meetup app like using Vue + Typescript: Welcome to Let's Meet!
https://github.com/kammradt/lets-meet-client

axios meet typescript vue vuetify vuex

Last synced: 5 days ago
JSON representation

πŸ’š A Meetup app like using Vue + Typescript: Welcome to Let's Meet!

Awesome Lists containing this project

README

        

Welcome to Let's Meet Client :v:


Let's meet logo

## Goals πŸ—ΊοΈ

Some time ago, I was interested on Typescript and building APIs with it, so I started a [NestJs course](https://github.com/kammradt/learning-nestjs). This project aims to apply what I learned, by creating a an API to a _[Meetup](https://www.meetup.com/) clone_ that I'm calling **Let's meet!**

## Description πŸ“

**Let's meet!** is a study project aiming to be a simpler version of [Meetup](https://www.meetup.com/).

It will allow users to create, manage and organize events.
You can verify more below!

### Development progress :bar_chart:

> All items listed below are based on the API, that you can verify [here]()

- [x] **Auth related**
- [x] Users should be able to register
- [x] Users should be able to login
- [x] Users should be able to view details about their account

* [ ] **Users related**

- [x] Users should be able to view all available events
- [x] Users should be able to filter events - [ ] Users should be able to retrieve their managed events
- [x] Users should be able to view details about a specific events (including attendees)
- [x] Users should be able to create events
- [ ] Users should be able to edit/cancel events
- [x] Users should be able to attend an event
- [x] Users should be able to cancel an attendance to an event - [ ] Users should be able to retrieve events that they are attending

* [ ] **Admin related**

- [ ] Admins should be able to retrieve information about all users
- [ ] Admins should be able to update a user role to Premium or even Admin
- [ ] Admins should be able to cancel any event

* [ ] **Future improvements**
- [x] Use a TS based front-end framework
- [x] Add state control (Vuex, Redux, etc.)
- [ ] Learn how test front-end stuff
- [ ] Add i18n

---

## How to use :globe_with_meridians:

API: https://api-lets-meet.herokuapp.com/ - [API repo](https://github.com/kammradt/lets-meet-api)
Web app: https://lets-meet.now.sh/

## How to use :house:

### Vue setup

Recommended TSC version: `Version 3.9.3`
Recommended Node version: `v12.16.3`
(It is easier to install using [nvm!](https://github.com/nvm-sh/nvm))

- Installing Node and Typescript:
`bash $ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash $ nvm install v12.16.3 $ npm install -g typescript`

> Vue has an amazing CLI tool, it is a good idea to install it!

- Installing Vue CLI:

```bash
$ npm install -g @vue/cli
```

- Development:

```bash
npm run serve
```

- Production:
```bash
npm run build
```

---

## Help is always welcome :wink:

> Because as you can see, I have absolute no ideia what I'm doing :satisfied:

### How can I help?

- You can [Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) this project and modify what you want. And then, send modifications using the [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) system.

### What is and How to create a Fork?

- A Fork is basically a copy of this repository, but in your account. So, you have access to all files and can do whatever you want with your version.
Using github is really easy to create a Fork, just follow:
> You just need to click on `Fork` button on the top right!
> ![Fork instructions](https://github.com/kammradt/lets-meet-client/blob/master/images/fork.gif)

### What is and How to create a Pull Request?

- A Pull Request is a way of putting code from multiple people together in a organized way. After your modifications on your own forked repository, you can commit those changes and push to it.
Now you have you repository updated with changes, but note that all those changes are only on your forked version.
How to put your version together with mine and have a better project? Really easy! Just follow:
> 1. Go to the Pull Request tab
> 2. Click on `new pull Request`
> 3. You can verify the modifications
> 4. Click on `Create pull Request`
> 5. It is a good ideia to write a description of what was added
> 6. Create it! Thanks so much!
> ![PR instructions](https://github.com/kammradt/lets-meet-client/blob/master/images/pr.gif)

## Author

πŸ‘€ **Vinicius Kammradt**

- Website: https://kammradt.now.sh/

- Twitter: [@kammzinho](https://twitter.com/kammzinho)

- Github: [@kammradt](https://github.com/kammradt)

- LinkedIn: [@vinicius-kammradt](https://linkedin.com/in/vinicius-kammradt)