Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dimimikadze/orca
Build modern community apps with React and Node.
https://github.com/dimimikadze/orca
community customer-engagement jamstack javacript mongodb nodejs orca react social-network typescript
Last synced: about 1 month ago
JSON representation
Build modern community apps with React and Node.
- Host: GitHub
- URL: https://github.com/dimimikadze/orca
- Owner: DimiMikadze
- License: mit
- Created: 2019-09-30T08:31:33.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-03-26T15:49:30.000Z (8 months ago)
- Last Synced: 2024-10-09T16:22:41.773Z (about 1 month ago)
- Topics: community, customer-engagement, jamstack, javacript, mongodb, nodejs, orca, react, social-network, typescript
- Language: TypeScript
- Homepage: https://dimimikadze.github.io/orca-docs
- Size: 865 KB
- Stars: 1,218
- Watchers: 51
- Forks: 294
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Launch faster with a Modern and Free community platform.
Within minutes, Orca gives you all the core features for building a community app,
which is beautifully designed, easy to use, and ready to scale.
## Features
Orca is a free and open-source community platform equipped with:
- **Real-time notifications** Be notified instantly when someone likes or comments on your post, follows you, messages you, etc.
- **Email notifications** Receive an email every time someone interacts with your profile or posts.
- **Messenger** Have a private conversation with other members via an instant messaging system.
- **Newsfeed and a Follow system** See the fresh posts of the members that you are following in your Newsfeed.
- **User presence system** See instantly when members become online or leave the app.
- **Responsive** Great user experience on every device and screen.
- **SEO-friendly** Built-in SEO best practices such as meta tags and page loading performance.
- **Branding** Customize the platform to match your brand.
- **UI library** Dozens of reusable UI components are included.
- **Search and Explore** Explore and Search for new members and their posts.
## Prerequisites
You'll need to have [Node](https://nodejs.org) >=12.20.0, [Yarn](https://yarnpkg.com), and [MongoDB](https://www.mongodb.com) installed and running on your machine.
## Quick start
```
npx create-orca-app my-app
```
This command will create a directory `my-app` inside a current folder. In that directory, it will generate an initial project and install dependencies.
Once the installation is done, you can run the app locally.
```
cd my-app
yarn dev
```
Then open [http://localhost:3000](http://localhost:3000) to see your app.
## Configuration
Although these steps are enough to create an Orca app and run it locally, you'll need to create an admin user, configure CDN and Email service to use all the Orca's features. The [Configuration Docs](https://dimimikadze.github.io/orca-docs/docs/getting-started/configuration) will walk you through all of it.
## Contributing
Thank you for considering contributing to Orca! The contribution guide can be found in the [Orca documentation](https://dimimikadze.github.io/orca-docs/docs/contributing).
## Documentation
See our dedicated [repository](https://github.com/dimimikadze/dimimikadze.github.io/orca-docs) for the Orca documentation, or view it [live](https://dimimikadze.github.io/orca-docs/docs/getting-started/installation).
## Core Contributors
Tom Kochievi
Rajendrasinh Parmar
## License
Orca is an open-source software [licensed as MIT](./LICENSE).