Comments (8)
I think we could still have a simple structure of the folder, not too deep, just high-level (2 levels max) folder structure.
I am looking at @Manthan109 suggestion https://github.com/Manthan109/XMeme#folder-structure, so nothing too big, but that gives an idea of the structure of the app (e.g.: where marshmallow schemas as located, and where db models are).
I also think the diagram anitab-org/mentorship-backend#530 can be a little hard to read
something like this, without mentioning the files (i.e., that are not frequently changed such as *_extension.py
files):
from bridge-in-tech-backend.
Hello there!
Thank you and congrats
Feel free to join us on AnitaB.org Open Source Zulip Community.
from bridge-in-tech-backend.
Thankyou for this issue. We are working towards integrating the bridge in tech backend and the mentorship system backend. This should make the project easier to setup.
from bridge-in-tech-backend.
@Manthan109 hey you can read this blog post or this google doc to know more about the project:)
Also the issues labelled as first-timers only here are a great start
from bridge-in-tech-backend.
@Manthan109 , if you're proposing to add the file/folder structure to README as per your example, IMO it will be unnecessary since contributors can see them on the repo (above README). Perhaps you can add something like this diagram but a much simpler version. Although, as @epicadk mentioned, when we fully integrate BIT backend to MS backend, the diagram will no longer be needed, so this temporary addition will be short lived.
from bridge-in-tech-backend.
Makes sense, @isabelcosta . @Manthan109 , I'll assign you to this now. Please refer to @isabelcosta suggestions on your approach to this issue
from bridge-in-tech-backend.
@isabelcosta So, If I have understood right I have to add the file structure as I did in my project up to 2 levels and add this to the docusaurus documentation but on mentorship backend and not on bridge-in-tech backend?
from bridge-in-tech-backend.
@Manthan109 any updates?
from bridge-in-tech-backend.
Related Issues (20)
- Improvement: Refactor code to use dict.get() method HOT 2
- Improvement: refactor expected_fields_validator HOT 10
- Task: Set up local environment HOT 7
- Improvement: Add typehints to User module HOT 3
- Improvement: Add typehints to Organization module HOT 3
- Improvement: Add typehints to Programs module HOT 6
- Research : Ideas for how to add members to an organization HOT 1
- Research : Integrate Notifications HOT 15
- Migrating Travis to Github action HOT 9
- Frontend UI Redesign HOT 3
- Migrating to Github Actions
- Fix tests failing on github actions HOT 6
- test
- Improve Github actions HOT 4
- Dev: Add BIT web gh-pages remote to CORS
- Dev: Move Docusaurus from surge to gh-pages HOT 3
- Docs : Add setup tutorial to `.github/ENV_SETUP_INSTRUCTION.md` HOT 3
- Update organization name from AnitaB.org to anitab-org in docusaurus config HOT 2
- Update github email and name in documentation workflow HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from bridge-in-tech-backend.