Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adarshaacharya/codetreats
In-browser IDE for running, collaborating, saving and sharing code snippets.
https://github.com/adarshaacharya/codetreats
codeeditor codetreats express hacktoberfest hacktoberfest-accepted hacktoberfest2021 heroku ide monaco-editor mongodb nodejs reactjs snippets socket-io typescript
Last synced: 3 months ago
JSON representation
In-browser IDE for running, collaborating, saving and sharing code snippets.
- Host: GitHub
- URL: https://github.com/adarshaacharya/codetreats
- Owner: adarshaacharya
- License: mit
- Created: 2020-08-05T12:24:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-10-24T02:53:06.000Z (about 3 years ago)
- Last Synced: 2023-03-03T01:25:06.413Z (almost 2 years ago)
- Topics: codeeditor, codetreats, express, hacktoberfest, hacktoberfest-accepted, hacktoberfest2021, heroku, ide, monaco-editor, mongodb, nodejs, reactjs, snippets, socket-io, typescript
- Language: TypeScript
- Homepage: https://codetreats.herokuapp.com/
- Size: 2.41 MB
- Stars: 28
- Watchers: 1
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
In-browser IDE for running, collaborating, saving and sharing code snippets.
## ⭐ Features
- In-browser IDE with VS Code like text editor having features like auto-completion, code-formatting
- 8+ Programming Languages support
- 15+ Themes Support 🤯
- Save snippets publicly with shareable link
- Search snippets with title
- Realtime Collaboration _(unlimited users)_ 🔥
- Realtime Chat 💥
> ⚠️ *Website isn't mobile friendly and for best experience use Google Chrome.*
## 📺 Prerequisites
Before running app locally make sure that you install following things:
- Nodejs with npm or yarn installed
- [Mongodb](https://www.mongodb.com/) as database.
- Strongly recommended to use [Robot 3T](https://robomongo.org/) as MongoDB GUI for local database setup or simply use [MongoDB Atlas](https://docs.atlas.mongodb.com/getting-started/) and paste token in `DATABASE_URI`
## 🚀 Local Development
### Step 1: Clone the repo
```bash
https://github.com/adarshaacharya/CodeTreats.git
```
## Step 2: Install dependencies
Install both client and server dependencies
```bash
# Install dependencies for server
$ npm install
# Install dependencies for client
$ npm run client:install
```
### Step 3: Configuration
1. Create `.env` file in project root dir
```bash
$ touch .env
```
2. Copy everything from `.env.example` as paste it in `.env`
3. Go to [Glot signup page](https://glot.io/auth/page/simple/register) and create new account.
4. Then [go to this page](https://glot.io/account/token) and copy & paste token in `GLOT_TOKEN = ` in `.env` file.
### Step 4: Usage
Now you can run the application by :
```bash
# Run the client & server with concurrently (for running full application)
$ npm run dev
# Run the Express server only
$ npm run server
# Run the React client only
$ npm run client
# Server runs on http://localhost:5000 and client on http://localhost:3000
```
## ⛵ Production Deployment
There is a Heroku post build script so that you do not have to compile your React frontend manually, it is done on the server. Simply push to Heroku and it will build and load the client index.html page
## 🤝 Contributing
Contributions, issues and feature requests are welcome. After cloning & setting up project locally, you can just submit a PR to this repo and it will be deployed once it's accepted.
**⚠️ Note - Commit & PR Title :**
It’s good to have descriptive commit messages so that other folks can make sense of what your commit is doing.
This project uses [Husky](https://github.com/typicode/husky/blob/master/README.md) prevent bad `git commit`, `git push` and more 🐶 \_woof!
Read [conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.3/) before making the commit message.
## 👏🏻 Show your support
Give a ⭐️ if you like the project!
## 👤 Author
- Website:
- Twitter: [@adarshatweets](https://twitter.com/adarshatweets)
- Github: [@adarshaacharya](https://github.com/adarshaacharya)
- LinkedIn: [@adarshaacharya](https://linkedin.com/in/adarshaacharya)
## 📝 License
Copyright © 2020 [Aadarsha Acharya](https://github.com/adarshaacharya).
This project is [MIT](https://github.com/adarshaacharya/CodeTreats/blob/master/LICENSE) licensed.