Skip to content

Latest commit

 

History

History
67 lines (47 loc) · 3.72 KB

README.md

File metadata and controls

67 lines (47 loc) · 3.72 KB

Find It!

NCSS 2017, Group 3 - the best group

Running from source

Clone the repo:

$ git clone https://github.com/ncss/projects-2017-3/

Create the database:

cd db/
python db_create.py
  • Only clone the repository and create the database when running for first time.

Start the server:

python server.py

The server runs by default at localhost:8888. (Type localhost:8888 into a browser to view)

Here is a version of how to run the project with screenshots.

How to run Find It!, with screenshots

This how-to is made quickly for GitHub Desktop.

  • If you'd like to use GitHub Desktop, click on the link to go download it and set it up.

  • Then visit the link for our project: GitHub projects 2017 group 3 link and click on 'Clone or download'. Then click 'Open in Desktop' to open it in GitHub Desktop. Screenshot of 'Clone or download' NCSS group 3 project on GitHub You'll be prompted to choose a location to save the repository on your computer, and then the project will start cloning.

  • Once the project has finished cloning, it will appear in the left panel under the heading 'GitHub' on GitHub Desktop. Then, Open in Terminal/Git Shell by right-clicking on the project name: Right click on project name with mouse hovering over 'Open in Terminal' (The name of the option 'Open in Terminal/Git Shell' is just dependent on whichever Operating System you are using. These screenshots here are for Mac OS.)

In shell, if you want to run a Python file named file.py for example, you can type in python db_create.pyonce you're in the directory of the file.

  • Only if first time running, we need to create the database (this also contains the dummy data). python db/db_create.py is the command to run the file that creates the database (on at least Windows I think). Here is a screenshot (this is for Mac where python3 is for running python3) Running python db/db_create.py in terminal

  • Now, each time you want to run the project, you need the server. Run python server.py Running python server.py in terminal If it worked and the server's working, you'll see the Reloading... waiting for requests on http://localhost:8888 message appear.

  • After you have the server, open a browser and type in localhost:8888 to see our awesome site Screenshot of website with localhost:8888 in the URL bar

Messages will keep appearing in the shell as you do things on the site, this is expected.

How to open the project (in Atom), with screenshots

  • You can view code in Atom by going to Repository>Open in Atom on Mac, I think there's a button on Windows with the Atom icon. Screenshot for Mac: Screenshot of GitHub Desktop zoomed in on Repository>Open in Atom or you can also right-click on the project name and then Open in Atom: Screenshot of GitHub Desktop zoomed in on right-click project name and mouse hover over 'Open in Atom'

If you have any ideas or comments on this tutorial, please feel very free to add.