Lushlyrics

Secure, seamless, and user-friendly login system for effortless access control.

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Implemented user authentication, authorization, and password recovery for Lushlyrics' website. The new features include a user-friendly registration. login, and password recovery views and authentication and authorization workflows.

Improvements

• Users are now able to create accounts easily and conveniently.
• Email verification added as part of the verification process
• Users are now be able to log in and out of the system conveniently
• Users now able to recover their accounts if they lose their credentials.

Built With

• 
• 
• 
• 

(back to top)

Set up

The first thing to do is to clone the repository:

$ git clone https://github.com/mohammedwed/lushlyrics-webapp-django.git
$ cd lushlyrics-webapp-django

Create a virtual environment to install dependencies in and activate it:

$ virtualenv2 --no-site-packages env
$ source env/scripts/activate

Then install the dependencies:

(env)$ pip install -r requirements.txt

Note the (env) in front of the prompt. This indicates that this terminal session operates in a virtual environment set up by virtualenv2.

Run the following command to install the dependencies needed for the frontend. Node.js is required:

(env)$ npm install

Once npm has finished downloading the dependencies:

(env)$ cd Lushlyrics
(env)$ python manage.py runserver

Open another terminal and run

(env)$ cd Lushlyrics
(env)$ npm run start

Finally, navigate to http://localhost:8000/.

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Get a free API Key at https://example.com
2. Clone the repo

   git clone https://github.com/your_username_/Project-Name.git

3. Install NPM packages

   npm install

4. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Api endpoints
• Menu-items endpoints
• User group management endpoints
• Cart management endpoints
• Order management endpoints
• Additional Steps
• Throttling
  See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @your_twitter - email@example.com

Project Link: https://github.com/your_username/repo_name

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• Choose an Open Source License
• GitHub Emoji Cheat Sheet
• Malven's Flexbox Cheatsheet
• Malven's Grid Cheatsheet
• Img Shields
• GitHub Pages
• Font Awesome
• React Icons

(back to top)