https://github.com/murphyadam/formy
Formy is very simple search form for searching places (businesses, landmarks, locations, etc) with the help of Google Places.
https://github.com/murphyadam/formy
django python react redux typescript
Last synced: 3 months ago
JSON representation
Formy is very simple search form for searching places (businesses, landmarks, locations, etc) with the help of Google Places.
- Host: GitHub
- URL: https://github.com/murphyadam/formy
- Owner: MurphyAdam
- Created: 2021-10-27T10:28:35.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-10-27T11:30:07.000Z (over 4 years ago)
- Last Synced: 2026-01-03T20:44:01.219Z (6 months ago)
- Topics: django, python, react, redux, typescript
- Language: TypeScript
- Homepage: https://formy-search.herokuapp.com/
- Size: 709 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Formy
This is a simple places search app made with the help of Google Places
This project is split into two parts: Front-end (client) and back-end (server)
The docs below shall help you get started to run the application on your local machine, or deploy it.
## Stack
This project uses the following stack:
1. Python
2. JavasScript/ TypeScript
3. Django and Django-rest-framework
4. React + Redux
5. REST
6. Material-UI/ CSCC
## Demo
Demo deployed on a pipeline on Heroku connected to our GitHub (Automatic deploys)
https://formy-search.herokuapp.com/
## Get started
If you would like to run the build without installing the client side (Node modules),
Please skip the Client part below
### Client
If you would like to run the client server, please make sure you have the latest Node.js version >= 16,
alongside a package manager such as `yarn` or `npm` (this project uses yarn), and follow the steps below:
1. in the root directory of `client` where the package.json file is located, use your favourite package
manager to install the client dependencies. E.g: `yarn` or `npm install`
2. spin the development server up.
in your terminal, according to your package manager, run the local server by typing either `yarn start`
or `npm run start`. This should start a local development server at 127.0.0.1, port 3000
### Backend
- Requirments:
This project is written in `Python 3.9` using `django 3.2.8` and `django-rest-framework 3.12.4`
- Install:
Please create a virtual environment and install the project requirements found in the file `requirements.txt`.
## Tests
- backend:
To run the tests, please run `python manage.py test` in the server
- front-end:
To run the tests, please run `yarn test` in the client dir