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

Commit fe6ddca

Browse files
committed
updated essential info
1 parent a28059f commit fe6ddca

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,9 @@ Music, Forum, Leaderboard, **1v1 challenges**
7575

7676
- ➔ Social Tools
7777

78-
**Messaging, User Finder, Bored!**
78+
- ➔ Messaging
79+
80+
**User Finder, Bored!**
7981

8082
Unreleased features are **highlighted**.
8183

@@ -93,30 +95,32 @@ Unreleased features are **highlighted**.
9395

9496
## Modules part of only the Proprietary repository
9597

96-
- Coder
98+
- Upcoming Coding workspace
9799
- Fusion
98100
- Messages and its notification system
99101
- Upcoming 1v1 features
100102
- Upcoming Bored! feature
101103
- Upcoming Help! feature
102-
- Updated Music Player
104+
- Music Player ( updated )
103105

104106
If you want to work on anything apart from the modules present in the open-source repository, please contact us.
105107

106108
## Features that are part of the open-source repo
107109

108-
109110
- Notes
110111
- Tasks
112+
- Coder
111113
- Quizzes
112114
- Forum
113115
- Resources
114116
- Upcoming User Finder
115-
- Current Music player
117+
- Music player ( current version )
116118
- Blog Platform by DomeCode
117119

118120
You will be able to contribute to all of these features and they *will be kept* open-source forever. You will also be able to contribute to the base front-end of DomeCode without having to apply to be a part of the internal development team.
119121

122+
Once we are profitable, we might reconsider some of the modules that are kept private to be made open-source. We <3 open-source. However, at the same time it's important to minimize the chances of replicability by making the parts of DomeCode that are not generic in nature, closed-source at least until we are a bigger player in the market.
123+
120124
## Setup
121125

122126
Please refer to the [Contribution Guide](https://github.com/The-Domecode/domecode-opensource/blob/master/contribution.md)
@@ -135,7 +139,7 @@ Please refer to the [Contribution Guide](https://github.com/The-Domecode/domecod
135139

136140
- 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.
137141

138-
142+
- The Postgres DB user should be a SUPERUSER to apply migrations for the latest search technique being used in DomeCode.
139143

140144
Here's a dummy .env file you can use:
141145
```
@@ -154,6 +158,9 @@ AWS_STORAGE_BUCKET_NAME="hc"
154158
ADMIN_URL="admin"
155159
JUDGE0_RAPID_API_KEY="abc"
156160
HONEYBADGER_KEY="abc"
161+
DB_NAME="domecode"
162+
DB_USER="dummy"
163+
DB_PASSWORD="password"
157164
```
158165

159166
- If you want to do something involving the judge api, get your own api key from [here](https://rapidapi.com/hermanzdosilovic/api/judge0) and place that key in the ```JUDGE0_RAPID_API_KEY``` variable in .env
@@ -182,7 +189,7 @@ Note : In the repo's language stats, HTML and CSS have been disabled intentional
182189
## 🧑 Contributors
183190

184191
- [Arth Tyagi](https://github.com/arthtyagi) - Founder, CEO, Full Stack Developer, [DomeCode](https://domecode.com/)
185-
- [Arhaan Ahmad](https://github.com/Arhaan) - Back-end developer, [DomeCode](https://domecode.com/).
192+
- [Arhaan Ahmad](https://github.com/Arhaan) - Back-end Developer, [DomeCode](https://domecode.com/).
186193
- [Yash Karandikar](https://github.com/karx1) - Junior Dev, [DomeCode](https://domecode.com/).
187194

188195
## 💼 Work on DomeCode

0 commit comments

Comments
 (0)