Skip to content
This repository was archived by the owner on Jun 13, 2022. It is now read-only.

Commit a767bd5

Browse files
committed
added some essential info to the readme
1 parent f9dd326 commit a767bd5

1 file changed

Lines changed: 70 additions & 23 deletions

File tree

README.md

Lines changed: 70 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -14,27 +14,70 @@
1414

1515
[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/C0C4226J0)
1616

17-
DomeCode open-source is the open-source codebase of DomeCode, a unified platform to learn code, practice, discuss, plan tasks, take notes, listen to music and more!
17+
# What is DomeCode?
18+
19+
DomeCode is a coding platform that unifies the coding experience by providing all relevant resources and tools in a single platform.
20+
On DomeCode, you can practice in six languages including Rust, C, C++, Go, Java and Python. Learn, take notes, discuss stuff on the forum, connect with other developers, collaborate on projects with them, be a part of a developer community and way more!
21+
22+
This repository is the open-source codebase of DomeCode, a unified platform to learn code, practice, discuss, plan tasks, take notes, listen to music and more!
1823

1924
The AGPL license allows the free use of this code-base in other free open-source projects. However, the codebase is NOT free to use for paid projects. For paid projects, the use of this codebase would be paid as well.
2025

26+
If anyone wants to share their experience using DomeCode, you can share it with me personally on Discord(zuck#9454) or send me an email at `founder@domecode.com`.
27+
28+
## Why should you use DomeCode?
29+
30+
- You don’t need to navigate to dozens of platforms anymore, DomeCode organizes all the tools and resources for you.
31+
- You can finally focus more on programming instead of finding the “right” website for every small thing.
32+
- You get to collaborate with developers around you.
33+
- DomeCode provides its users with a significant productivity boost.
34+
- Save around 30% of your overall time spent in the process of learning a programming concept, taking notes, and practicing it.
35+
- You simply get more without any hassle.
36+
37+
Join our community on [Discord!](https://discord.gg/ZwTJPNB).
38+
39+
## Tools in DomeCode
40+
41+
At the time of this writing on 2nd September, 2020,
42+
DomeCode offers the user an array of future that make DomeCode truly a unified platform.
43+
44+
* ➔ Growth Tools
45+
Tracks, Practice, Quizzes, Fusion, **Help!, Certificate Programs**
46+
47+
* ➔ Planning Tools
48+
Notes, Creator, Tasks
49+
50+
* ➔ Miscellaneous Tools
51+
Music, Forum, Leaderboard, **1v1 challenges**
52+
53+
* ➔ Social Tools
54+
**Messaging, User Finder, Bored!**
55+
Unreleased features are highlighted.
56+
57+
## Milestones so far
58+
59+
- Launched the alpha version on 5th August, 2020.
60+
- 15000 web traffic requests within 24 hours of the alpha release.
61+
- 275+ registered users as of 2nd September, 2020.
62+
- Bounce Rate optimal according to Google Analytics.
63+
- Total number of users over the past 4 weeks ( both registered and unregistered ) sum up to 2,400 according to Google Analytics.
64+
- More than 2 sessions on average per user where the users include unregistered users as well.
65+
- **Upcoming** - Stable Release in October.
66+
- **Upcoming** - An exclusive blog. Apply to become a DomeCode blogger [here](https://forms.gle/8Q6gQYBJxsKYgxMP7).
67+
2168
## Setup
2269

23-
* Clone a fork of this repository.
70+
* Clone your fork of this repository.
2471
* Run the migrations.
2572
* Run this on your localhost.
2673

27-
2874
Use the`devmanage.py` command instead of `manage.py` command on development environments.
2975
This project uses `decouple` so make sure to make a local `.env` file in your root directory of the project containing all the variables with dummy values.
3076
The variables you should include are the ones with `config()` next to them in the `devmanage.py` file. If there's an error due to the missing value of an environment variable, it can be fixed with ease by passing in appropriate variables. It's pretty generic stuff.
3177

3278
Once you're done with that, you can start working on fixing the nitty gritty details, make improvements, finding issues and reporting them in the issues tab of this repository. Create PRs and have fun!
3379

34-
35-
**Note :You should take note of that if you are working on the fork of this repository, you have to sync it before pushing changes to the fork and making a PR to this repo. How to sync changes made on this repo to your fork? Have a look at [this](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork). **
36-
37-
80+
**Note :You should take note of that if you are working on the fork of this repository, you have to sync it before pushing changes to the fork and making a PR to this repo. How to sync changes made on this repo to your fork? Have a look at [this](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork).**
3881

3982
## Code Style
4083

@@ -48,8 +91,24 @@ Note : In the repo's language stats, HTML and CSS have been disabled intentional
4891

4992
## Contributors
5093

51-
* [Arth Tyagi](https://github.com/arthtyagi) - Project Maintainer and Founder of [DomeCode](https://github.com/arthtyagi)
52-
* [Arhaan Ahmad](https://github.com/Arhaan)
94+
* [Arth Tyagi](https://github.com/arthtyagi) - Founder,CEO, Full Stack Developer,[DomeCode](https://domecode.com/)
95+
* [Arhaan Ahmad](https://github.com/Arhaan) - Back-end developer, [DomeCode](https://domecode.com/).
96+
97+
## Want to work on DomeCode?
98+
99+
If you want to be an outside collaborator with involvement in DomeCode at your own frequency, just make contributions in this repository.
100+
101+
However, if you want to be part of the DomeCode's new features development team ( we have a private repository for that ) and want to have any future benefits that MIGHT be tied to working on DomeCode in any form, apply at `iwantin@domecode.com` for the following positions :
102+
103+
* Full Stack Web Developer ( FrontEnd - React.js/Vue.js/Angular.js ( preferably React.js) ; Backend - Django/Flask(preferably Django) )
104+
* Generalist Full Stack Developer ( include what technologies you know of inside the email )
105+
* Front-End Developer ( React.js/Vue.js/Angular.js ( preferably React.js ) along with basic understanding of Python.
106+
* Backend Developer ( Django/Flask ( preferably Django ) ; basic understanding of JS and a basic sense of aesthetics )
107+
* Mobile Developer ( React Native/Flutter, Native Android/Native iOS ( preferably ReactNative for Android and iOS )
108+
* ML Developer ( fluent in Python, familiar with TensorFlow )
109+
**OR**
110+
111+
Apply using [this](https://forms.gle/Y4Cza1i3yxdsWRvo7).
53112

54113
## A few other projects you might wanna look out for
55114

@@ -63,26 +122,14 @@ Visit [here](https://github.com/arthtyagi/geddit/).
63122

64123
### Judge
65124

66-
_Being used in DomeCode_
67-
68125
![judge (1)](https://user-images.githubusercontent.com/41021374/88198064-eccce880-cc60-11ea-8356-c86f7caddac8.png)
69126

70127
![image](https://user-images.githubusercontent.com/41021374/88192318-0454a300-cc5a-11ea-9b2a-1baa9597b957.png)
71128

72129
Visit [here](https://github.com/arthtyagi/judge) which is also available as PyPi package [here](https://pypi.org/project/django-judge/).
73130

74131
Installable with : `pip install django-judge`
75-
Thanks for visiting this pre-launch landing page!
132+
Thanks for visiting this!
76133

77-
#### Want to work on DomeCode?
78134

79-
If you want to be an outside collaborator with involvement in DomeCode at your own frequency, just make contributions in this repository.
80-
81-
However, if you want to be part of the DomeCode's new features development team ( we have a private repository for that ) and want to have any future benefits that MIGHT be tied to working on DomeCode in any form, apply at `iwantin@domecode.com` for the following positions :
82-
83-
* Full Stack Web Developer ( FrontEnd - React.js/Vue.js/Angular.js ( preferably React.js) ; Backend - Django/Flask(preferably Django) )
84-
* Generalist Full Stack Developer ( include what technologies you know of inside the email )
85-
* Front-End Developer ( React.js/Vue.js/Angular.js ( preferably React.js ) along with basic understanding of Python.
86-
* Backend Developer ( Django/Flask ( preferably Django ) ; basic understanding of JS and a basic sense of aesthetics )
87-
* Mobile Developer ( React Native/Flutter, Native Android/Native iOS ( preferably ReactNative for Android and iOS )
88-
* ML Developer ( fluent in Python, familiar with TensorFlow )
135+

0 commit comments

Comments
 (0)