Skip to content

Commit

Permalink
Merge pull request #177 from marvelai-org/Opensource-setup-updates
Browse files Browse the repository at this point in the history
Updates to readme and code of conduct
  • Loading branch information
yunusj authored Nov 20, 2024
2 parents 92ef258 + 51191a7 commit 5a65c3c
Show file tree
Hide file tree
Showing 3 changed files with 155 additions and 31 deletions.
Binary file added Marvel Architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 30 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
![image](https://github.com/user-attachments/assets/04e5f5a4-9ba7-4887-a158-bca181f7391c)


# Marvel AI Platform
Marvel is an open source project by Radical having chatbot and smart tools for teachers.
Marvel AI is an open-source project by Reality AI, designed to provide smart tools and chatbots to assist teachers in education. The platform leverages Firebase, Next.js, and various AI components to create a seamless learning experience.

![Next.js](https://img.shields.io/badge/Next.js-12.3.0-blue)
![React](https://img.shields.io/badge/React-18.2.0-blue)
![Redux Toolkit](https://img.shields.io/badge/Redux%20Toolkit-%5E1.9.5-purple)
![Emotion](https://img.shields.io/badge/Emotion-%5E11.11.0-pink)
![MUI](https://img.shields.io/badge/MUI-%5E5.13.0-blue)
![Firebase](https://img.shields.io/badge/Firebase-%5E9.22.0-orange)
![Axios](https://img.shields.io/badge/Axios-%5E1.4.0-brightgreen)
![React Hook Form](https://img.shields.io/badge/React%20Hook%20Form-%5E7.43.9-lightgrey)
![Remark](https://img.shields.io/badge/Remark-%5E15.0.1-yellow)
![ESLint](https://img.shields.io/badge/ESLint-%5E8.40.0-blue)
![Prettier](https://img.shields.io/badge/Prettier-%5E2.8.8-ff69b4)
![Husky](https://img.shields.io/badge/Husky-%5E9.0.11-yellow)

## Table of Contents

Expand All @@ -14,7 +30,7 @@ Marvel is an open source project by Radical having chatbot and smart tools for t
## Architecture
The "Marvel" platform is structured into two main components: Firebase and AI. The Firebase side, detailed in this repository, encompasses both the frontend, developed with NextJS and hosted on Firebase Hosting, and the backend, which includes user management and session handling via Firebase Functions like `signUpUser` and `createChatSession`. The `communicator` and `toolCommunicator` functions act as proxies, facilitating interaction between the Firebase infrastructure and the AI services, ensuring seamless data flow and integration. Firestore DB is utilized for data storage. The AI components, housed in a separate repository, include a chatbot and tools like "Quizify" and "YouTube Flashcard Generator."

![Architecture Diagram](architecture.png)
![Architecture Diagram](https://github.com/marvelai-org/marvel-platform/blob/2400bf1b10af77b57976778a108f3f2296aa5215/Marvel%20Architecture.png)

### Folder Structure
## Folder Structure Overview
Expand Down Expand Up @@ -47,7 +63,7 @@ The "Marvel" platform is structured into two main components: Firebase and AI. T
To set up the project, follow these steps:

## Local Development
1. Clone the repository: `git clone https://github.com/radicalxdev/marvel-platform`
1. Clone the repository: `git clone https://github.com/marvelai-org/marvel-platform`
2. Create your firebase project on google firebase console
3. Create a firestore database instance
4. Get firebase config from firebase project settings in firebase console and save it to .env (create in root of this project, see sample.env for refrence)
Expand All @@ -70,16 +86,24 @@ To set up the project, follow these steps:
2. Open another terminal simultaneously and start the frontend project, run the following command: `npm run frontend:dev`

## Cloud Deployment
1. Clone the repository: `git clone https://github.com/radicalxdev/marvel-platform`
1. Clone the repository: `git clone https://github.com/marvelai-org/marvel-platform`
2. Navigate to back-end project directory: `cd functions`
3. Install dependencies: `npm install`
4. Navigate to front-end directory: `cd ../frontend`
5. Install dependencies: `npm install`
5. Navigate to the root directory and run deploy: `cd .. && npm run deploy`

## Contributing

If you would like to contribute to the project, please follow the guidelines in the `CONTRIBUTING.md` file.
1. Fork the Repository: Create a personal fork of the repository to work on.
2. Create a Branch: For each new feature or bug fix, create a new branch from the develop branch.
3. Implement Changes: Make your changes, ensuring they adhere to the project’s coding standards.
4. Commit Changes: Commit your changes with clear, descriptive messages.
5. Push to Your Fork: Push your changes to your forked repository.
6. Open a Pull Request: Navigate to the original repository and open a pull request from your branch to the develop branch.
7. Code Review: Engage in the code review process, addressing any feedback provided.
8. Merge: Once approved, your changes will be merged into the develop branch.

For detailed instructions, refer to the [CONTRIBUTING.md](https://github.com/marvelai-org/marvel-platform/blob/2400bf1b10af77b57976778a108f3f2296aa5215/contributing.md) file in the repository.

## License

Expand Down
150 changes: 125 additions & 25 deletions code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,133 @@
# Code of Conduct
We are committed to fostering a welcoming and inclusive environment for all contributors.

# Our Pledge
We as contributors pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, level of experience, nationality, personal appearance, race, and religion.
# Contributor Covenant Code of Conduct

# Our Standards
Examples of behavior that contributes to creating a positive environment include:
## Our Pledge

Using welcoming and inclusive language
Being respectful of differing viewpoints and experiences
Gracefully accepting constructive criticism
Focusing on what is best for the community
Showing empathy towards other contributors
Examples of unacceptable behavior by participants include:
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

The use of sexual language or imagery
Personal attacks
Trolling or insulting/derogatory comments
Public or private harassment
Publishing someone's private information, such as a physical or electronic address, without explicit permission
Other conduct which could reasonably be considered inappropriate in a professional setting
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

# Enforcement Responsibilities
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainers at rex@radicalx.co. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project maintainers are obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
## Our Standards

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
Examples of behavior that contributes to a positive environment for our
community include:

# Attribution
This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

# Contact info
If you have any further questions regarding this Code of Conduct, please contact us at rex@radicalx.co.
Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
support@realityai.tech.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations

0 comments on commit 5a65c3c

Please sign in to comment.