SMARTJ is a web application designed to help active job seekers practice their interview skills and find available jobs in their field of study.
SMARTJ provides:
- Interactive interview practice sessions with customizable formats
- Access to a diverse question bank tailored to user needs
- Flexible answer formats including video recording and written responses
- A curated job finder with pre-filtered links to software engineering positions
Interview skills are crucial for job seekers. SMARTJ aims to:
- Improve users' interview performance through customized practice
- Streamline the job search process for software engineering roles
- Provide a platform for self-reflection and skill improvement
SMARTJ is built using a modern web development stack. Here are the key technologies and libraries we've used:
- React.js - A JavaScript library for building user interfaces
- Node.js - JavaScript runtime built on Chrome's V8 JavaScript engine
- npm - Package manager for JavaScript
- MongoDB - Database for keeping track of users.
- Bootstrap - CSS framework for responsive and mobile-first websites
- Font Awesome - Icon set and toolkit
- Jest - JavaScript Testing Framework
- React Testing Library - Testing utilities for React
- Node.js for running web server
Recommended version: v21.7.3
Note: Node.js installation cincludes npm installation - Npm (Node Package Manager) for installing packages from npm registry
Downloading Node.js should automatically install npm for you - MongoDB For running a database that will keep track of user data
Recommended version: v8.0.0 - OpenAI API Key For running the ChatGPT grading. You will need to sign up, add balance if needed and generate a secret key for use as an environment variable.
- Clone the repo:
git clone https://github.com/SOFTENG310-Team4/SMARTJ.git - Navigate to root directory of the Repository
- Create a .env file named ".env" in the root folder and add your OpenAI API key (should be in the format REACTAPP_OPENAI_API_KEY=_your key)
- Run
npm installto install the necessary dependencies - Start the MongoDB server, whether through client or
mongodvia command line - Run
node server.jsto start the backend server - Start a new terminal and run
npm startto run the web application - After running npm start, open your browser and navigate to
http://localhost:3000
- To run the testing of the SMARTJ project, navigate to the root directory and run
npm test -- --watchAll=false - To access more specific Watch Usage testing (such as running failed tests), simply run
npm test
There are two main features of the SMARTJ application: Interview Practice and Job Finder
This section gives a brief rundown on how to use these features.
- Navigate to the Interview Practice page through the home page or navigation bar
- Choose your interview setting preference
- Perform the interview practice
- Navigate to the Job Finder page through the home page or navigation bar
- On the page, you can choose to click and be redirected to 6 Software Engineering curated job finding links from sites such as Prosple
This project is licensed under the MIT License - see the LICENSE file for details.
- v1.0.0 - Initial release with basic functionality (A1 Release)
If you need help, please:
- Check our Contributing Guidelines for information on how to report issues
- Contact us using our collaborative email: [email protected]
We welcome contributions! Please see our Contributing Guidelines for more details on how to get started.
- We acknowledge our Initial Project developers, Anna Lin, Seth Yoo, Tony Yin, Minsung Cho, Jaewon Kim, Rusiru Dharmasekhara for their hard work
- We acknowledge our A2 developers who continued the project, Albert Sun, Quaid Sage, Joel Kendall, Maahir Nafis, Allan Xu, Max Chen
- Special Thanks to our Project Supervisor, Kelly Blincoe for allowing the project to flourish
This project is part of the SOFTENG 310 course at the University of Auckland.