/ignite-reactjs-ignews

Code produced during module 3 of the Ignite course on the React Js trail of the Rocketseat platform.

Primary LanguageTypeScriptMIT LicenseMIT

Ig.news logo

License: MIT PRs Welcome

Code produced during module 3 of the Ignite course on the React Js trail of the Rocketseat platform.

In this module, a subscription platform for text content was developed, using the concepts of JAMStack. FaunaDB was used as a database, Stripe for payment integration and Prismic CMS for content management.

Ig.news

📌 Table of Contents

💻 Technologies

This project was developed with the following technologies:

👷 Installation

You need to install Node.js and Yarn first, then in order to clone the project via HTTPS, run this command:

git clone https://github.com/monteiro-alexandre/ignite-reactjs-ignews.git

SSH URLs provide access to a Git repository via SSH, a secure protocol. If you use a SSH key registered in your Github account, clone the project using this command:

git clone git@github.com:monteiro-alexandre/ignite-reactjs-ignews.git

Install dependencies

yarn install

Or

npm install

FaunaDB, Stripe, Prismic, Github's OAuth and Environment Variables configuration

This project uses FaunaDB, Stripe, Prismic and Github's OAuth authentication, and for proper functioning, you must create your account on these services, if you don't already have it and make some settings.

FaunaDB Configuration

See FaunaDB Configuration documentation to configure your FaunaDB and fill in your environment variables.

Stripe Configuration

See Stripe Configuration documentation to configure your Stripe and fill in your environment variables.

Prismic Configuration

See Prismic Configuration documentation to configure your Prismic and fill in your environment variables.

Github's OAuth Configuration

See Github's OAuth Configuration documentation to configure your Github's OAuth and fill in your environment variables.

🏃 Getting Started

Run the following command in order to start the application in a development environment:

yarn dev

🐛 Issues

Feel free to file a new issue with a respective title and description on the the Ignews repository. If you already found a solution to your problem, I would love to review your pull request! Have a look at our contribution guidelines to find out about the coding standards.

🎉 Contributing

Check out the contributing page to see the best places to file issues, start discussions and begin contributing.

📕 License

This project is licensed under the MIT License - see the LICENSE file for details.