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.

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

create initial README #8

Merged
merged 2 commits into from
Jun 29, 2021
Merged
Changes from all commits
Commits
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
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
## Build and grow massive on-line communities with Rocket.Chat


### Developer quick start

During development, our data provider is a headless CMS, strapi. It is used only during development and build time, not during production.

Start strapi in a shell:

```
git clone https://github.com/rocketchat/RC4Community
cd backend
npm i
npm run develop
```
Check http://localhost:1337 to access strapi.

If you're using WSL2 on Windows also running Docker Desktop, port 1337 may not be available on your system. To use port 3000 instead, change this line in `config/server.js` file:

```
port: env.int('PORT', 3000),
```
The application is written on nextjs and deployable on all nextjs compatible microservices and scaled deployment platforms.

Start the application in a shell:

```
cd ../frontend
npm i
npm run dev
```

Now RC4Community should be accessible from http://localhost:8090

If you've changed the strapi port to 3000, use the following line to start the application instead:

```
export NEXT_PUBLIC_STRAPI_API_URL=http://localhost:3000;npm run dev
```


You can now modify code in the application via standard nextjs dev workflow and following its best practices.