Tech Savagery: Next.js - Typescript - Chakra UI Demo

Full stack web app built for testing + learning purposes.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Built With

• Next.js
• TypeScript
• Chakra UI
• MongoDb

Getting Started

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

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/TechSavagery/Next.js-Typescript-Chakra-UI.git

2. Install NPM packages

   npm install

Getting Started from Scratch

1. Create Blank Repo
2. Install Next.js typescript example npx create-next-app --example with-typescript {project-name}
3. Install TypeScript npm install --save-dev typescript
4. Enable TypeScript npm install --save-dev @types/react @types/react-dom @types/node
5. Install Chakra UI npm i @chakra-ui/react @emotion/react @emotion/styled framer-motion
6. Setup Api Middlewares
7. Setup Api Endpoints

Usage

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

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

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - @techsavagery - [email protected]

Project Link: https://github.com/techsavagery/tests-cypress

Acknowledgements