Scriptium

Scriptium is a project designed to facilitate research and foster discussions among users about religious texts from around the world. It aggregates religious texts from reputable sources recognized by their respective communities. You can find these sources in the /about section of the Scriptium website.

Scriptium is primarily intended for theological research and the exchange of ideas about religious texts, but it’s also designed to be accessible for everyday readers. Moreover, Scriptium actively listens to user feedback to improve its features and functionality.

---

Scriptium Backend

This repository provides the backend for the Scriptium Frontend. It is built with .NET and Entity Framework Core (EF Core).

• The backend serves as an API that handles data management, user interactions, authentication, and more.
• All project dependencies are listed in the .csproj file.

Note: This documentation currently focuses on public endpoints. More details will be added soon.

---

📡 Endpoints (Upcoming...)

The API will expose various public endpoints for interacting with scriptures, user content, and analytical data.
Stay tuned for updates!

---

Contribute

Thank you for your interest in contributing to Scriptium! Your contributions help improve the project and create a better experience for everyone. Please follow the steps below to ensure of a contribution process:

🚀 How to Contribute

1. Check for Existing Issues:
   Before starting to work on something, check the Issues to see if the problem has already been reported or if someone else is working on it.

   • If the issue exists: Feel free to join the discussion.
   • If not: Open a new issue to describe the problem or feature request.

2. Fork the Repository:

   • Click the "Fork" button at the top right of the repository page.

   • Clone your forked repository to your local machine:

     git clone https://github.com/kaanoz1/Scriptium-backend.git

3. Create a Branch:

   • Always create a new branch for your changes:

     git checkout -b feature-name

4. Work on Your Changes:

   • Make the necessary updates in your branch.

   • If you opened an issue, keep an eye on any feedback or comments.

   • Write clear and concise commit messages:

     git add .
     git commit -m "Fix: Issue description here"

5. Test Your Changes:

   • Ensure your changes don’t break existing features.
   • Run the project locally to verify everything works as expected.

6. Submit a Pull Request (PR):

   • Push your branch to GitHub:

     git push origin "Feat: Feature Name Here"

   • Go to the original repository and click "New Pull Request."

   • Provide a detailed description of the changes you’ve made, including:

     • The problem you’re solving
     • How you fixed it
     • Any additional notes for reviewers

7. Review and Feedback:

   • A review process will follow. Address any requested changes promptly.
   • Discussions are always welcome to ensure code quality and project alignment.

---

Thank You!

Every contribution no matters—big or small. Although I’m currently the sole maintainer of this project, your support is invaluable. Thank you for being a part of Scriptium and helping it grow!

---

License

This project is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) License.

For more details, see the LICENSE file or visit the Creative Commons License.