https://github.com/ebeagusamuel/members-only

https://github.com/ebeagusamuel/members-only

Last synced: 12 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/ebeagusamuel/members-only
• Owner: ebeagusamuel
• Created: 2020-06-29T12:36:33.000Z (over 4 years ago)
• Default Branch: development
• Last Pushed: 2023-01-19T19:39:21.000Z (almost 2 years ago)
• Last Synced: 2023-03-07T23:29:07.449Z (over 1 year ago)
• Language: Ruby
• Size: 1.38 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 32
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Members Only

This is a project on authentication. In this project we worked on creating and understanding how basic user authentication works, using devise gem in a rails application.

![screenshot](/app/assets/images/screenshot.png)

## Built with

  * Ruby on Rails

  * Devise gem

  * Bootstrap SASS 3

  * Linter (Github Actions, Rubocop)

## Getting Started

To get a local copy up and running follow these simple steps.

- On the project GitHub page, navigate to the main page of the repository [this page](https://github.com/ebeagusamuel/members-only.git).

- Under the repository name, locate and click on a green button named 'Clone or download'. 

- Copy the project URL as displayed.

- If you're running Windows Operating System, open your command prompt. On Linux, Open your terminal.

- Change the current working directory to the location where you want the cloned directory to be made. Leave as it is if the current location is where you want the project to be.

- Type `git clone`, and then paste the URL you copied in Step 3.


`$ git clone https://github.com/ebeagusamuel/members-only.git`

- Press Enter. Your local copy will be created.

Please Note that you must have github installed on your PC, this can be done [here](https://gist.github.com/derhuerst/1b15ff4652a867391f03).

### Prerequisites

Since all the code is written using ruby on rails, `Ruby Runtime >= 1.9` and `rails 6` is required to interpret the code. If you don't have ruby on rails runtime already setup on your computer, follow the instruction for your specific operating system on the [official installation guide](https://guides.rubyonrails.org/getting_started.html#creating-a-new-rails-project-installing-rails).

### Usage

After cloning on your computer, open the folder using your terminal/command prompt window and run

`bundle install`

`rails db:migrate`

`rails server`

## Authors

👤 **Ebeagu Samuel**

- Github: [@ebeagusamuel](https://github.com/ebeagusamuel)

- Twitter: [@samuelebeagu](twitter.com/ebeagu_samuel)

- Linkedin: [linkedin]()

👤 **Taofeek Olalere**

- Github: [@teekaytech](https://github.com/teekaytech)

- Twitter: [@ola_lere](https://twitter.com/ola_lere)

- Linkedin: [olaleretaofeek](https://linkedin.com/in/olaleretaofeek)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!

   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.


Feel free to check the [issues page](issues/).

## Show your support

Give a ⭐️ if you like this project.

## 📝 License

This project is [MIT](lic.url) licensed.

## Acknowledgements

- [The Odin Project](https://www.theodinproject.com/courses/ruby-on-rails/lessons/authentication)

- [GitHub Actions](https://github.com/microverseinc/linters-config/tree/master/ror)