Skip to content

Latest commit

 

History

History
105 lines (59 loc) · 3.67 KB

README.md

File metadata and controls

105 lines (59 loc) · 3.67 KB
Raw

Chill&chat API

CodeQL

This is the Chill&chat API, this api provides information to the mobile app while interacting to the MongoDB database.

License

This repository is licensed under the MIT License and is free for use. Please see the LICENSE file for the full license.

Copyright (C) 2021-2023 Alvin cheng

Contribution

You are welcome to contribute to this project at any time. To contribute, please fork the project and make changes in the forked repository. Then make a pull request under the Pull request tab. Please make sure your code has passed all tests, and the code explanation is clear before submitting, and please make sure to follow the GitHub official community guidelines when submitting any code to the Chill&chat repository.

I look forward to seeing your contributions to Chill&chat!

Bugs and issues

If you have found any bug(s) please post them in the Issues tab in this repository. Please explain the problem and post any error messages or codes, also include a list of instructions to reproduce this bug or problem.

Contact

For support and more information regarding Chill&chat products and services, please contact us with the details below and quote "Chill&chat" in your post:

Email: [email protected]

Chill&chat ID: fa3b185c-6d04-41ea-8082-10cc594ad8f6

To run

The Chill&chat API is made with NodeJS please follow the steps to clone/run.

To clone:

git clone https://github.com/Chillandchat/api/

Eviroment file setup:

KEY= # Replace with custom API key.
DATABASE_URI= # Replace with MongoDB database URI.
PORT= # Replace with port number.
API_EMAIL= # Replace with email
API_EMAIL_PASS= # Replace with email password
GIPHY_KEY= # Replace with Giphy key

Build and run:

Yarn:

yarn && yarn build && yarn start # Installs packages, builds and starts the app with yarn

Npm:

npm install && npm build && npm start # Installs packages, builds and starts the app with npm

Note:

From v1.8.0, you must have ffmpeg installed on your machine to convert GIFs from mp4 video formats.

More information and download link: https://ffmpeg.org/

Docs

The API documentation can be found in the wiki or by clicking here

User safety agreement

  • We will ensure that all users' private information will be private no matter what, even to the developers.

  • Private data is kept safe in a database with top-of-the-line safety and encryption, we also ensure no data is sold or shared with any third parties.

  • We will also make sure to listen to any community safety concerns or complaints.

  • We will ban and delete accounts of users that are unruly or share inappropriate data.

  • Developers will be active to eliminate security issues/bugs

All the above will be enforced to ensure Chill&chat is safe!

Credits:

Alvin cheng - Software engineer

Brianna cheng - UI&UX designer

Special thanks

Jonathan yao

❤️ Made With Love ❤️