Open-listings is a listings' website, particularly, similar to the open-listings we see on newspapers. Let's bring the same idea to the web; This time offering rich input forms, interactive UI, and an interactive Map all presented to the user with multiple languages and most importantly respecting users' privacy.
Open-Listings is not production ready! There are many bugs. I've built it in a mindset like make the whole thing happen quickly!
Open-listings as a listing web-app is unique in a way and this is why:
- It runs very fast,
- It offers multiple sections (based on your target users),
- It supports tags (like hundreds),
- Geo-locations (up to thousands),
- Open possibilities for choices of geolocation to be targeted (country, states),
- Multiple human languages for the web-app and the posted content.
- All are supported in all aspects (UI, back-end, DB, choice of deployment, and configuration).
- Navigation: view a listing, view some tags, view some regions, and change language, ...
- Search: performant advanced search using text based on indexes, intelligent autocompletion based on a whole scan of DB, geo-search (by radius), and front-end search.
- Add a listing in a section, Send a comment to the author.
- Basic admin moderation of listings (approve or delete a new listing), check anonymous visitors' countries by number.
- Multi-language support on back and front end.
- Maps integration is quite good, you need to check that by yourself!
- A pretty rich UI using dozens of lightweight JS browser libraries (all are very carefully picked !).
| Listing page | Homepage | Admin dashboard |
|---|---|---|
 |
 |
 |
.env files hold secret keys and configurations that you want to hide.
All other configurations should live in /config/{NODE_env}.json file.
- Create environment files
touch /.env && /client/.env - Fulfill environment variables on server (note that
apiis meant for easy deployment on your machine without a UI. At this stage, I'm focusing on bugs so I made this distinction.
You can run it with NODE_ENV=production to have UI.
NODE_ENV=api/production
GCLOUD_STORAGE_BUCKET=NameOfBucket
JWT_SECRET=Just@Passw0rd
COOKIE_NAME=Just@Name
SECRET_PATH=Just@Passw0rd
PASSWORD=Just@Passw0rd
ADMIN_PASS=PASSWORD
ADMIN_EMAIL=moderatorEmail
ADMIN_EMAIL2=moderatorEmail
SENDGRID_API_KEY=
APP_NAME=OLisings-en/fr/ar/..
DEFAULT_LANG=en-US/fr/ar/..
IS_REDIS_CACHE=false # Consider turning to true, to use cached listings (next version)
IS_MONGO_DB=false # Whether to use a MongoDB server or just NeDB (for development purposes!) think of NeDB as Sqlite with a MongoDB API!NeDB support for development purposes is a work in progress, and contribution is welcome :)
Also client keys:
GOOGLE_FONT_API=
MAPBOX_GEO_SEARCH=- This has been tested only on Linux
- Make sure there are no running MongoDB and Redis instances, ports
['6379', '27017', '8090', '2019', '3000', '9000']are free. Better to not have them installed all on the host machine - Just install Docker and then run
./deploy.sh
- Install Node the run
npm installon root./folder and on./clientfolder - Prepare databases
- Redis database must be up
- MongoDB must be up with the following DBs and collections
DBs: {listings_db} & Collections: {listing, words, comment, users, userstemp, visitors-default-current, visitors-default}
- Fulfill Google Cloud credentials (for storage) (optional for API env)
./credentials/service-account.json - Change environment files accordingly
- Verify configuration on your environments as you want here
/config - Prepare some data-sets:
npm run download:assets - Build the whole project:
npm run build
The app is targeting Linux mainly, for me it runs without Docker images on Windows Server as well (with Windows installation of MongoDB/Redis). If installation didn't go as expected; Please open an issue with the steps of installation so we make this smoother.
The app bootstraps for some country as an example, with a simple tweak, you could bootstrap the app on another location with a different map.
Just check ./.env and client/.env for APP_NAME, DEFAULT_LAT, etc.
With a different geoJSON data format, you might need to change encoders in both files /data/geo/geoJSONEncoder.js and /client/data/geo/geoJSONEncoder.js.
Open-listings UI relies heavily on third parties. The following open-source solutions have these traits in common: they are bright, lightweight, well-maintained, and popular. they are simply the best I could find. So big thanks to their creators.
By this table, I'm giving reference to their collaborators and to keep track on their updates.
- Merging the same code with different indentations is hell, so it is important to keep one coding style between forks. I suggest installing VSCode ESlint (Prettier also) that connects automatically with
./eslintrc.jsand./client/./eslintrc.js.- "dbaeumer.vscode-eslint"
- "esbenp.prettier-vscode"
Algebra-insights Inc.
France 2023
View license
If
you have any questions about our projects you can email [email protected]