Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gjuliao/marketplace-rails

rails marketplace app
https://github.com/gjuliao/marketplace-rails

Last synced: 6 days ago
JSON representation

rails marketplace app

Awesome Lists containing this project

README 

        






Marketplace Rails App





# 📗 Table of Contents



- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ](#faq)

- [📝 License](#license)



# 📖 Marketplace Rails App 



** Marketplace rails app is a platform that allows users to become project owners or project customers.  It allows to make a purchase or receive an order from a project.  App gets a fee for each project purchased by customers.**



## 🛠 Built With 



### Tech Stack 



 



  This app was built with Rails.

  



### Key Features 



- **Stripe integration for purchases and partial or complete refund**

- **Allows users to purchase projects or become project owners.**

- **Has admin dashboard with permissions settings**



(back to top)



## 🚀 Live Demo 



- [Pending deployment](https://pending-deployment.com/)



(back to top)



## 💻 Getting Started 



To get the content of this project locally you need to run the following commands in your terminal:



and follow these steps.



### Prerequisites



- IDE(code editor) like: **Vscode**, **Sublime**, etc.

- [Git](https://www.linode.com/docs/guides/how-to-install-git-on-linux-mac-and-windows/)



### Setup



Clone this repository to your desired folder:



1. Download the **Zip** file or clone the repo with:

   `bash git clone [email protected]:gjuliao/workshop.git`

2. To access cloned directory run:

   `bash cd workshop`

3. Open it with the live server



### Install



> To install linters and other project's dependencies run:

> `bundle install `



### Usage



To run the project, execute the following command:



### Run tests



To run tests, run the following command:



Test for Linters For tracking linter errors locally you need to follow these steps:



1. For tracking linter errors in HTML files run:

   `bash npx hint . `

2. For tracking linter errors in CSS or SASS files run:

   `bash npx stylelint "**/*.{css,scss}" `

3. For tracking linter errors in javascript files run:

   `bash npx eslint . `



### Deployment



You can deploy this project using:



(back to top)



## 👥 Authors 

👤 **Giovanni Juliao**



- GitHub: [@gjuliao](https://github.com/gjuliao)



(back to top)



## 🔭 Future Features 



- [ ] **[Add more styles to show section]**

- [ ] **[Add more features to project]**

- [ ] **[Allow more crud operations to users & admin]**



(back to top)



## 🤝 Contributing 



Contributions, issues, and feature requests are welcome!



Feel free to check the [issues page]([../../issues/](https://github.com/gjuliao/workshop/issues)).



(back to top)



## ⭐️ Show your support 



> Write a message to encourage readers to support your project



If you like this project please give us a star!



(back to top)



## 🙏 Acknowledgments 



> Give credit to everyone who inspired your codebase.



I would like to thank to the rails team for making amazing programming language.



(back to top)



## 📝 License 



This project is [MIT](./MIT.md) licensed.



(back to top)