Skip to content

Latest commit

 

History

History
245 lines (191 loc) · 7.91 KB

README.md

File metadata and controls

245 lines (191 loc) · 7.91 KB
Raw

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

The BookShelve

This is a Capstone project.
Explore the docs »

View Demo · View the Video · Design for this Project · Requirements · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

Built With

In this section you will find a list of technologies used in this project.

Development:

Test:

Production:

Getting Started

Fork the repository and create a local version cloning the repo. Move to the repository inside the command line using: cd and go inside the path to the file.

inside your browser go to http://localhost:3000/, changing the port number in case you chose a custom one explore the application

Prerequisites

  • Ruby v2.7.2
  • Ruby on Rails v6.1.1
  • Postgres: >=11

Installations:

  • Bundle: 
    bundle install
  • Create DB: 
    rails db:create
  • Migrate DB: 
    rails db:migrate
  • and then run the server: 
    rails server
  • Open live demo with this link in your browser: 
    localhost:3000

  • *** if you already have using port 3000: 
    rails server -p 3030

Where the number beside -p flag can be any port you want.

Usage

  • create an account by clicking sign up, filling in the form and click the sign up button
  • use the navigation bar on top to see all posts ('All section'), you will see the new posts ('This Posts are created only like Admin User')
  • you can UpVote Book Reviews by clicking on the Like button
  • Create a New Category: on the dropdown menu click on New Category, here you can type any word for category and you can select in a checkbox if you want to display it on the navbar.
  • Manage Categories: Here you can put the categories that you like for display in the Navbar.
  • Create a new Post Cliking on the dropdown menu marked 'Create a new post' there you will see the form to create a new one and clicking on the save button.
  • Update User Account: Go to the dropdown menu and select User settings.
  • Delete User Account: Go to the dropdown menu select User settings and here you will find the option to delete your account :(.

If you want to try the admin functions in this project you will need to do this:

  • run the Rails Console
rails c
  • Update the First User to Admin
User.first.update(admin: true)

This will enable the admin functions.

Usage in Deployed App (Admin User)

Roadmap

See the open issues for a list of proposed features (and known issues).

Run tests

The project contains unit and integration test. to run these test Move to the repository inside the command line using

cd

and the path to the file and run the command:

bundle exec rspec
  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

License

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

Authors

👤 Carlos Robles

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!