Some time ago, I was interested on Typescript and building APIs with it, so I started a NestJs course. This project aims to apply what I learned, by creating a an API to a Meetup clone that I'm calling Let's meet!
Let's meet! is a study project aiming to be a simpler version of Meetup.
It will allow users to create, manage and organize events. You can verify more below!
All items listed below are based on the API, that you can verify here
- Auth related
- Users should be able to register
- Users should be able to login
- Users should be able to view details about their account
-
Users related
- Users should be able to view all available events
- Users should be able to filter events - [ ] Users should be able to retrieve their managed events
- Users should be able to view details about a specific events (including attendees)
- Users should be able to create events
- Users should be able to edit/cancel events
- Users should be able to attend an event
- 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
- Use a TS based front-end framework
- Add state control (Vuex, Redux, etc.)
- Learn how test front-end stuff
- Add i18n
API: https://api-lets-meet.herokuapp.com/ - API repo
Web app: https://lets-meet.now.sh/
Recommended TSC version: Version 3.9.3
Recommended Node version: v12.16.3
(It is easier to install using 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:
$ npm install -g @vue/cli
-
Development:
npm run serve
-
Production:
npm run build
Because as you can see, I have absolute no ideia what I'm doing π
- You can Fork this project and modify what you want. And then, send modifications using the Pull Request system.
- 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:
- 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:
π€ Vinicius Kammradt
-
Website: https://kammradt.now.sh/
-
Twitter: @kammzinho
-
Github: @kammradt
-
LinkedIn: @vinicius-kammradt