https://github.com/sadmanyasar/proptory-webapp-nextjs
https://github.com/sadmanyasar/proptory-webapp-nextjs
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/sadmanyasar/proptory-webapp-nextjs
- Owner: SadmanYasar
- Created: 2023-07-29T14:54:34.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-06T21:10:03.000Z (about 2 years ago)
- Last Synced: 2024-04-16T17:38:07.765Z (over 1 year ago)
- Language: HTML
- Size: 54.8 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Proptory Web App 🏠
Table of Contents
- [About](#about)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Manual Setup](#manual-setup)
- [Userflow](#userflow)
- [Database UML Diagram](#database-uml-diagram)
- [Roadmap](#roadmap)
- [Support](#support)
- [License](#license)
---
## About
Proptory Web App
### Built With
- [Next.JS](https://nextjs.org/)
- [Typescript](https://www.typescriptlang.org/)
- [Tailwind CSS](https://tailwindcss.com/)
- [Prisma(Postgres)](https://www.prisma.io/)
- [Zenstack](https://zenstack.dev/)
## Getting Started
Production: [Click to view](https://proptory.com/)
### Manual Setup
Make sure you have the latest [Node.js](https://nodejs.org/en/) installed
1. Clone this repository by running the following in a terminal
```sh
git clone https://github.com/furtoryapp/furtory.git
```
2. Change directory
```
cd proptory-webapp
```
3. Use npm to install dependencies
```
npm install
```
4. (Deprecated) Make sure mongodb is running:
```
#Linux
sudo systemctl restart mongod
#OR
mongod
```
Refer here for more information: [Here for Windows](https://stackoverflow.com/questions/20796714/how-do-i-start-mongo-db-from-windows) and [Here for Ubuntu](https://www.mongodb.com/docs/manual/tutorial/install-mongodb-on-ubuntu/#run-mongodb-community-edition)
5. (Deprecated) Create a .env.local file in the root directory and paste the following:
```
MONGO_URI=mongodb://my_user:my_pwd@localhost:27017/proptory
JWT_SECRET=YOURSECRET
JWT_SECRET_ADMIN=ADMINSECRET
```
6. Create a .env file in the root directory and paste the following:
```
# This is for creating links to send through Whatsapp
NEXT_PUBLIC_URI=https://proptory.com/listings
```
7. Start the project using npm or yarn
```
npm start
```
## Userflow
## Database UML Diagram
## Roadmap
See the [open issues]() for a list of proposed features (and known issues).
- [Feature Requests]() (Add your votes using the 👍 reaction)
- [Newest Bugs]()
## Support
Reach out to the maintainer at one of the following places:
- [GitHub discussions]()
- The email which is located [in GitHub profile]()
## License
See [COPYING](COPYING) for more information.
Backlog
1. Update UI to use tailwind UI
2. Add modal search with price filter
3. Debounce search
1. For each Create, Upate, Delete, use appropirate search library method to manipulate the search index
2. Debounce search using InstantSearch.js
4. Update Mongoose with Prisma