first commit

.env_example

@@ -0,0 +1,10 @@
+## Create a file name with .env, then copy this file and paste over there and fill the details.
+
+# Get the Mongodb URL from their site
+MONGODB_URI= 
+# Your PORT for the API to work on
+PORT=
+# Node Environment [ production or development ], use development to log errors.
+NODE_ENV=
+# Creates Log files [ true/false ]
+LOGGER=

.gitignore

@@ -0,0 +1,19 @@
+# Environment variables
+.env
+
+
+# dependencies
+/node_modules
+
+# Private files
+/private
+
+
+# jetbrains
+.idea/
+
+# vscode
+.vscode/
+
+# Logs
+/logs

.prettierrc.json

@@ -0,0 +1,10 @@
+{
+  "useTabs": false,
+  "tabWidth": 2,
+  "semi": false,
+  "trailingComma": "es5",
+  "proseWrap": "preserve",
+  "printWidth": 80,
+  "arrowParens": "avoid",
+  "singleQuote": true
+}

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* 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 community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hey.kyoyo@gmail.com or on [Discord](). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+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.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,89 @@
+# Contributing to Animu
+
+We love your input! We want to make contributing to this project as easy as possible, whether it's:
+
+- Submitting a fix
+- Reporting an issue
+- Becoming a maintainer
+- Proposing new features
+- Discussing the current state of the code
+
+## Code of Conduct
+
+The code of conduct is described in [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Frequently Asked Questions (FAQs)
+
+<!--- I thought it would be great to have a list of FAQs for the project to help save time for new contributors--->
+
+    - Q: [The Question?]
+    - A: [The Answer!]
+
+## Feature Request
+
+Great Feature Requests tend to have:
+
+- A quick idea summary.
+- What & why you wanted to add the specific feature.
+- Additional context like images, links to resources to implement the feature etc, etc.
+
+## Development Process
+
+Pull requests are the best way to propose changes. We actively welcome your pull requests and invite you to submit pull requests directly <a href="https://github.com/AnimuAPI/Animu/pulls">here</a>, and after review, these can be merged into the project.
+
+## Pull Requests
+
+1. Fork the repo and pr to `staging` branch only.
+2. If you've added code that should be tested, add some test examples.
+3. Ensure to describe your pull request.
+
+## Issues
+
+Please ensure your description is
+clear and has sufficient instructions to be able to reproduce the issue. Report a bug by <a href="https://github.com/AnimuAPI/Animu/issues">opening a new issue</a>; it's that easy!
+
+## Running the API Locally
+
+**Requirements**
+
+- Node >= 12.x
+- MongoDB
+
+**1. Create a database**
+
+Create a MongoDB database.
+
+If you don't have MongoDB setup locally, then you can use [MongoDB Atlas][mongodb/atlas] to create a free hosted database.
+
+**2. Environment Variables**
+
+You need to set the `MONGODB_URI` environment variable to point to your database.
+
+Create a file called `.env` in the root directory of the project. Copy everything from `.env_example` and replace `<your-database-uri>` with the connection string for your database, _other env variables info are commented in the file itself._
+
+```shell
+MONGODB_URI=<your-mongodb-uri>
+```
+
+**3. Installing dependencies**
+
+```shell
+$ npm install
+```
+
+**4. Starting the Server**
+
+The server will automatically restart when you make changes to the code.
+
+```shell
+$ npm run dev
+```
+
+**And you're done!**
+
+## License
+
+By contributing to Animu, you agree that your contributions will be licensed
+under the [LICENSE file](LICENSE).
+
+[mongodb/atlas]: https://www.mongodb.com/cloud/atlas

DOCS.md

@@ -0,0 +1 @@
+## Working in Progress...