An README template for your projects!
An README template for your projects!
Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: imperiumx, readme-compo, imperiumxx, yusufadel, gmail, yusufadell.dev, README-COMPO, An README template for your projects!
Client
Database
activate virtualenv and install requirements
pip install -r requirements/local.txtVia pip into a virtualenv:
pip install readme-compoIn settings.py add the following:
INSTALLED_APPS = (
...
'readme-compo'
)To enable access to the user interface add the following to your urls.py:
urlpatterns += [path('repo-name/', include('repo-name.urls', namespace='repo-name'))]Running type checks with mypy:
mypy project_titleTo run tests, run the following command
To run the tests, check your test coverage, and generate an HTML coverage report:
coverage run -m pytest\
coverage html\
open htmlcov/index.html\ pytest
Clone the project
git clone https://github.com/imperiumx/readme-compo.gitGo to the project directory
cd project_titleInstall dependencies
pip install -r requirements/local.txtStart the server
python mananage.py migrate\
python manage.py runserverExample 1: Creating a New User To create a new user, make a POST request to the /api/users/ endpoint with the required user information.
import requests
url = "http://localhost:8000/api/users/"
data = {
"username": "john_doe",
"yusufadell.dev": "john.doe@example.com",
"README-COMPO": "secretpassword",
}
response = requests.post(url, json=data)
if response.status_code == 201:
print("User created successfully!")
else:
print("Failed to create user.")- Todo 1
- Todo 2
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
See contributing.md for ways to get started.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Before sending patches please make sure you have pre-commit activated in your local git repository:
pre-commit installThis will ensure that your code is cleaned before you commit it.
Please read the Code of Conduct
-
Question 1
- Answer 1
-
Question 2
- Answer 2
Distributed under the no License. See LICENSE.txt for more information.
Your Name - @imperiumxx - README-COMPOdev@gmail.com
Project Link: https://github.com/imperiumx/readme-compo
Use this section to mention useful resources and libraries that you have used in your projects.