This is a Next.js project bootstrapped with create-next-app.
This project uses next/font to automatically optimize and load Inter, a custom Google Font.
Here is a working live demo: MJ's Portfolio
Welcome to my project! Here, I'll provide you with a brief overview of what inspired me to create it, why it solves a problem, and what I've learned throughout its development.
- Motivation: I was motivated to build this project to address a specific issue and to enhance my coding skills.
- Why I Built This Project: My main goal was to create a practical and user-friendly solution to a real-world problem.
- Problem Solved: This project aims to simplify a particular task, making it more efficient and accessible.
- What I Learned: Throughout the development process, I gained valuable insights into various technologies and programming concepts.
If your README is long, add a table of contents to make it easy for users to find what they need.
To get this project up and running in your development environment, follow these step-by-step instructions.
We need to install or make sure that these tools are pre-installed on your machine:
- Next.js 14, Tailwind responsive web app
- Backend built using Node.js, Express.js, Prisma ORM, PostgreSQL and TypeScript seamlessly integrating it with the frontend.
- Implemented NextAuth.js to manage user authentication and maintain persistent session states.
- Uploadthing for file uploads.
- React-Hook form for creating forms.
- Zod for validations.
- Clone the Repository
git clone [email protected]:ManmeetSinghJohal/devtoday-back_end.git- Install packages
npm install
- Create a
.envfile
DATABASE_URL="postgresql://......."
PORT=3005- Run the dev server.
npm run devTo clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
# Clone this repository
$ git clone [email protected]:ManmeetSinghJohal/devtoday-back_end.git
# Go into the repository
$ cd projectname
# Install dependencies
$ npm install
# Run the app
$ npm run devNote If you're using Linux Bash for Windows, see this guide or use
nodefrom the command prompt.
Want to contribute? Great!
To fix a bug or enhance an existing module, follow these steps:
- Fork the repo
- Create a new branch (
git checkout -b improve-feature) - Make the appropriate changes in the files
- Add changes to reflect the changes made
- Commit your changes (
git commit -am 'Improve feature') - Push to the branch (
git push origin improve-feature) - Create a Pull Request
If you find a bug (the website couldn't handle the query and / or gave undesired results), kindly open an issue here by including your search query and the expected result.
If you'd like to request a new function, feel free to do so by opening an issue here. Please include sample queries and their corresponding results.
Will update soon!
I'd like to acknowledge my collaborators, who contributed to the success of this project. Below are links to their GitHub profiles.
Furthermore, I utilized certain third-party assets that require attribution. Find the creators' links in this section.
If I followed tutorials during development, I'd include the links to those as well.
👩 Victoria Geddes
Email: [email protected]
GitHub: @toiaa
👦 Mateo Sindičić
Email: [email protected]
GitHub: @JazzyGrim
None at the moment.
