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.

Sign up for GitHub

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

Update README.md #118

Closed
wants to merge 1 commit into from
Closed

Update README.md #118

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 23 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,28 @@
![Commudle Logo](https://commudle.com/assets/images/commudle-logo152.png)

# Commudle
[www.commudle.com](https://commudle.com)
# [Commudle](https://commudle.com)
### This is a community management platform for Tech Communities across the world. The inspiration being the personal experiences of Community Organizers. 🔆
### With Commudle, Manage your Tech Community,
### Organize Events, Learn & Grow, together. 💻

This is a community management platform for Tech Communities across the world. The inspiration being the personal experiences of Community Organizers.
## Why Commudle?
There are about 26.4 million software developers in the world. And that's just the estimate for professionals.
And one of the huge sources of motivation and learning for these Developers is Tech Communities in their region, and beyond. Commudle is a platform to provide for all these Communities and Developers. We aim to provide a platform where all the amazing content, ranging from slides, to sessions (even links to those) are all at one place. We want to know what those amazing side projects you have built, even if it's yet to be given those finishing touches.


## To setup
## Main features of Commudle
- ### Communities
- You can connect with Developers across the world who are learning and building together. Here are some of the most active communities!
- ### Labs 👩‍💻👨‍💻
- A place where you will find tutorials created by everyone who learnt something new and wants to make it easy for others to learn too!
- ### Community Builds 💡
- From coding a small, simple and useful Project, to Slides which you used for a Talk, share something which is your Build!


## To setup commudle on your local machine
- Install Node.js and npm (at least version 13 of Node.js and at least version 6 of npm)
- Install [@angular/cli](https://cli.angular.io/)
- Clone the project.
- Clone the project. `git clone https://github.com/commudle/commudle-ng`
- Run `npm install`.
- Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`.
- The development server directly interacts with the production APIs.
Expand All @@ -26,13 +39,17 @@ This is a community management platform for Tech Communities across the world. T
- In the left side navigation bar, under *Storage* you can find *Cookies*.
- By clicking on it, you can find a cookie named **commudle_user_auth** with its corresponding value.
- Copy this particular cookie and its value to `http://localhost:4200`'s cookies and refresh the page to get signed in.


### To Contribute to Commudle, checkout 🔭
- [Contribution Guidelines](CONTRIBUTING.md)
- [Contributors.md](CONTRIBUTORS.md)
- [Code Of Conduct](CODE_OF_CONDUCT.md)


## Build for production
- Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.


## Design Framework / UI Kit
## Design Framework / UI Kit 🎨🖌️
- We are using [Nebular](https://akveo.github.io/nebular/) which uses [Eva Design System](https://eva.design/) in commudle-admin