Skip to content

ace-racer/AnuragChatterjeeProfile

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

68 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A web application which contains a timeline of my academic and professional journey so far

View running application

My Profile

References

Base template was obtained from here: http://getbootstrap.com/2.3.2/examples/fluid.html

How to run the application locally

Run from local by serving from an HTTP server. Steps to set up HTTP server quickly:

  1. Install NPM
  2. npm install http-server -g from the command line
  3. http-server "File location from where to server the files"
  4. Open a browser and enter http://127.0.0.1:8080/index.html to get the home screen

Frameworks used

  1. NPM to run a local server - This was required to locally check if data was correctly fetched from JSON files in the Angular controller
  2. Angular JS v1.2 - Angular is used extensively to perform data binding and show data from the JSON files that are stored in the ProfileData folder. The search functionality in the Projects page shows the power of data binding with a few lines of code
  3. Bootstrap v2.3 - Bootstrap is used to make the complete web app responsive to different screen sizes

How to update the app to show your, yes, your!!, profile

  1. Fork and clone the source code to your local machine
  2. Navigate to the ProfileData folder
  3. Update the data in the below folders based on what they contain and following the format of the existing data:
    • communitytools.json: Details of community tools that you may have developed
    • highlights.json: Your image and professional highlights that will be shown when the web app loads
    • links.json: The details of the various channels that one can find you active on!
    • otheractivities.json: Details of other relevant activities that you are doing and want the world to know about!
    • projects.json: Details of cool projects that you have worked on and want the world to know about. Do note that there is an Awesome search feature in the projects page based on the tags. So, choose your tags wisely!!
    • generaldetails.json: The name of the user and the sections that one will see in your web page. Well, you would not want to add items to the list of sections and might want to rename the sections only. However, if you want to add your own cool new section, then you would need to perform the items in the next section (no pun intended)

Add a new section

  1. Before I continue, it is expected that you have some basic understanding of how Angular works.
  2. Design the data model of the data that is to be shown in the new section and define it as a JSON file and put it inside the ProfileData folder.
  3. Add your section to the generaldetails.json following the format of the existing data
  4. Navigate to app/scripts and open dataSvc.js. Add a method there and perform a get operation to retrieve the values from the newly created JSON
  5. Add an Angular controller in the same location following a similar pattern of the existing controllers
  6. Navigate to app/views and add a view that would show your data the way you want it to. As a starting point, you can refer to the existing views.
  7. Go back to app/scripts and open routeConfig.js and add an entry there corresponding to your section ID, controller and view
  8. Finally, add your Angular controller script to index.js as a script tag
  9. While updating functionality in an existing section you would need to update the corresponding controller, view or data JSON and no other file needs to be updated

Deploying the application to the internet

Please refer the link here on how to host your source code in GitHub as GitHub pages. This will enable you to host your profile as a GitHub page and allow people all over the world to access your profile via the internet.

New features

  1. Simple pagination for upto 50 records added to projects page for easy access! Pagination works for searches also.

About

A web application to highlight my academic and professional journey

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors