dcodesdev / cheatly

Welcome to Cheatly

Cheatly is a simple cheatsheet builder to help you create cheatsheets to study. You can also share the cheatsheets you make with your audience.

Cheatly is made with Next.js and TypeScript.

Installation

Environment variables

• MONGO_URI
• TWITTER_API_KEY
• TWITTER_API_SECRET
• TWITTER_ACCESS_TOKEN
• TWITTER_ACCESS_SECRET
• SERVER_URL (the server url in your case it would be http://localhost:3000)
• CLIENT_URL (the client url in your case it would be http://localhost:3000)

To install the app,

• Clone Cheatly repository:

git clone https://github.com/Dawsoncodes/cheatly

• Install the dependencies:

yarn

• Build the app

yarn build

• Run the app

yarn start

• Run the development environment with:

yarn dev

Now you can tinker with Cheatly. 😃

Contributions

Feel free to contribute to Cheatly. If you want to report a bug or make suggestions for improvement, raise an issue.

If you're new to making contributions, please read our Contributions guide.

While contributing, make sure to adhere to the Code of Conduct.

Thank you for checking Cheatly out. 😊

cheatly's Issues

Add prettier for code formatting

I believe prettier should be added to keep the codebase consistent.

Content placeholder for dashboard page

Both of the cheatsheet lists from the dashboard (my cheatsheets and my favorites) are fetched from the client-side, so they need to have a loading feedback or a content placeholder.

Pagination for dashboard page

The dashboard page has 2 lists of cheatsheets:

• My cheatsheets
• My favorites

Both of them need to have pagination.

Google auth login