Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Arteiii committed Oct 27, 2023
0 parents commit 2f99480
Show file tree
Hide file tree
Showing 34 changed files with 3,354 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .github/workflows/black_linter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Python Black Lint

on: [push, pull_request]

jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: psf/black@stable
with:
options: "--check --verbose --line-length 79"
src: "./backend"
version: "~= 22.0"
11 changes: 11 additions & 0 deletions .github/workflows/super_linter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: Python Black Lint

on: [push, pull_request]

jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: psf/black@stable
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/.vscode
26 changes: 26 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
MIT License with Copyleft and Commercial Use Attribution Clause

Copyright (c) 2023 wavy42

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

Copyleft Clause:
Any modifications, adaptations, or derivative works based on this Software must be made publicly available on GitHub, with proper attribution to the original developer wavy42, by adding a link to the original repository.

Commercial Use Attribution Clause:
For any commercial use of this Software, proper attribution to the original developer wavy42 is required, and a link to the original repository on GitHub must be provided.

THE SOFTWARE IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
83 changes: 83 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# Authly

Authly is a user management application built on [FastAPI](https://fastapi.tiangolo.com/) in Python, designed to provide user authentication and access control for various applications.

---

# 🚧 Work in Progress: Not Ready for Deployment

This project is currently under development and remains untested. As a result, it may not be secure and is not recommended for deployment. While contributions are welcome, we cannot provide a definite timeline for its completion.

Thank you for your interest and support in this open-source initiative.

## 🔍 Current Focus: Login Process and Database Operations

While the project is a work in progress and not yet ready for deployment, our current focus lies in strengthening the login process and optimizing database operations, including data storage mechanisms. Our team is dedicated to ensuring secure and efficient data management, with plans to address other areas in the future.

We greatly value any potential contributions and support from the community. We aim to make this project as robust and user-friendly as possible, building a strong foundation for future developments.

TODO:

- [ ] rework mongodb crud (beanie maybe)
- [ ] refactor some apiv1 stuff
- [ ] add cookie based login (redis)
- [ ] key add checks for already exist (auto add random num?)

## 💼 Commercial Use

For any commercial use of this software, proper attribution to the original developer wavy42 is required, and a link to the original repository on GitHub must be provided.

<!-- ## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Features](#features)
- [Contributing](#contributing)
- [Testing](#testing)
- [Credits](#credits)
- [License](#license)
## Installation
To set up Authly, please follow the instructions in the [Installation Guide](https://github.com/wavy42/authly/wiki/Installation-Guide) in our GitHub wiki.
For more detailed instructions and options, please refer to the same guide.
## Usage
Get started with Authly by following our setup guide, which can be found in the [Usage section of our GitHub wiki](https://github.com/wavy42/authly/wiki/Usage-Guide).
The wiki provides comprehensive information on all available options and configurations.
## Features
Authly offers a range of features, including but not limited to:
- User authentication and authorization
- Access control for different applications
- User subscription management
We are continuously developing and adding new features to enhance your user management experience. Stay tuned for more updates! -->

<!-- ## Contributing
We welcome contributions from the open-source community to make Authly even better. If you'd like to contribute, please check the [Contribution Guidelines](https://github.com/wavy42/authly/wiki/Contribution-Guidelines) in our GitHub wiki for details on how to get started. -->

<!-- ## Testing
We highly recommend writing tests for your application to ensure its reliability and functionality. You can find examples and instructions on how to run tests in the [Testing section of our GitHub wiki](https://github.com/wavy42/authly/wiki/Testing-Guide). -->

## Credits

🌟 Authly is developed by wavy42 & Arteii. 🚀

We appreciate the contributions of all our collaborators and supporters. 🙏

## License

Authly is licensed under the MIT License with additional clauses:

- **Copyleft Clause** 🔄 </br>
Any modifications, adaptations, or derivative works based on this software must be made publicly available on GitHub with proper attribution to the original developer wavy42 by adding a link to the original repository.

- **Commercial Use Attribution Clause** 💼 </br>
For any commercial use of this software, proper attribution to the original developer wavy42 is required, and a link to the original repository on GitHub must be provided.
22 changes: 22 additions & 0 deletions backend/Pipfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"

[packages]
pydantic-settings = "*"
argon2-cffi = "*"
bcrypt = "*"
motor = "*"
pydantic = "*"
fastapi = {extras = ["all"], version = "*"}
aioredis = "*"
exrex = "*"

[dev-packages]
uvicorn = {extras = ["standard"], version = "*"}
pytest = "*"
mypy = "*"

[requires]
python_version = "3.11"
Loading

0 comments on commit 2f99480

Please sign in to comment.