Skip to content

Latest commit

 

History

History
152 lines (108 loc) · 4.42 KB

README.md

File metadata and controls

152 lines (108 loc) · 4.42 KB
Raw

Logo

Citrine - Blockchain Application

An Ethereum exchange web application
View Demo

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. License
  5. Contact
  6. Acknowledgments

About The Project

Hero Screen Shot Services Screen Shot Transactions Screen Shot

This is a fully responsive Ethereum exchange blockchain web application built using web 3.0 technologies, such as MetaMask and Solidity.

Sections included in this web application are:

  • Hero - section where you can make the transaction
  • Services - section where the services offered are listed
  • Transactions - section that shows the transactions carried out

A transaction can contain a keyword that allows you to add a gif thanks to the Giphy SDK

(back to top)

Built With

(back to top)

Getting Started

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

Prerequisites

Install the lastest version of NPM

  • npm 
    npm install npm@latest -g

Installation

  1. Get a free Giphy API Key at https://developers.giphy.com/
  2. Clone the repo 
    git clone https://github.com/eliasjz36/citrine.git
  3. Go to client and install NPM packages 
    cd client && npm install
  4. Enter your Giphy API Key in a .env file 
    NEXT_PUBLIC_GIPHY_KEY = 'ENTER YOUR API';

(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

Elias Jimenez - elias-jimenez - bseliasjimenez14@gmail.com

Project Link: https://github.com/eliasjz36/citrine

(back to top)

Acknowledgments

(back to top)