README.md

📰 A simple typescript news platform!

Technologies Used • How To Use • Contributing • License

Made with ❤️ by Alvaro Israel 👏🏻 Get in Touch!

Hit the ⭐️ button if you like this project!

🏆 Technologies Used

• Next.js
• Node.js
• TypeScript
• Jest

💻 How to Use

Install system dependencies

• Install Git.
• Install Node.js.

Clone

In your command line:

$ git clone https://github.com/AlvaroIsrael/ignews-app.git
$ cd ignews-app

Frontend

# Go into project folder
$ cd ignews-app

# Install dependencies
$ yarn install --ignore-engines

# Build the app
$ yarn build

# Run the app
$ yarn start

🤝 Contributing

Fork this repository - click fork.

# Create your feature branch:
$ git checkout -b feature/myAwesomeFeature

# Commit your changes:
$ git commit -m 'feat: Added some new awesomeFeature'

# Push to the branch:
$ git push -u origin feature/myAwesomeFeature

Then go to Pull Requests and make a new one.

Resources:

• Read more about commits in conventional commits.
• Read more about how to open a Pull Request from GitHub official documentation.

📝 License

This software is under MIT license. See LICENSE for more details.